Struct Source

pub struct Source { /* private fields */ }

A Source represents the literal contents used to construct a given Regexp.

When Regexps are constructed with a /.../ literal, Regexp#source refers to the literal characters contained within the / delimiters. For example, /\t/.source.bytes has byte sequence [92, 116].

When Regexps are constructed with Regexp::compile, Regexp#source refers to the argument passed to compile. For example, Regexp.compile("\t").source.bytes has byte sequence [9].

Regexp#inspect prints "/#{source}/".

Implementations

impl Source

pub const fn new() -> Self

Construct a new, empty Source.

Examples

use spinoso_regexp::Source;

const SOURCE: Source = Source::new();
assert!(SOURCE.pattern().is_empty());
assert!(SOURCE.options().as_display_modifier().is_empty());

pub const fn with_pattern_and_options( pattern: Vec<u8>, options: Options, ) -> Self

Construct a new Source with the given pattern and Options.

Examples

use spinoso_regexp::{Options, Source};

let source = Source::with_pattern_and_options(
    b"Artichoke( Ruby)?".to_vec(),
    Options::with_ignore_case(),
);
assert_eq!(source.pattern(), b"Artichoke( Ruby)?");
assert_eq!(source.options().as_display_modifier(), "i");

pub const fn is_casefold(&self) -> bool

Whether this source was parsed with ignore case enabled.

Examples

use spinoso_regexp::{Options, Source};

let source = Source::new();
assert!(!source.is_casefold());

let source = Source::with_pattern_and_options(
    b"Artichoke( Ruby)?".to_vec(),
    Options::with_ignore_case(),
);
assert!(source.is_casefold());

pub const fn is_literal(&self) -> bool

Whether the Regexp was parsed as a literal, e.g. '/artichoke/i.

This enables Ruby parsers to inject whether a Regexp is a literal to the core library. Literal Regexps have some special behavior regarding capturing groups and report parse failures differently.

A source’s literal flag can only be set using Options::try_from_int.

pub fn pattern(&self) -> &[u8]

Extracts a slice containing the entire pattern.

Examples

use spinoso_regexp::{Options, Source};

let source = Source::with_pattern_and_options(
    b"Artichoke( Ruby)?".to_vec(),
    Options::with_ignore_case(),
);
assert_eq!(source.pattern(), b"Artichoke( Ruby)?");

pub const fn options(&self) -> Options

Return a copy of the underlying Options.

Examples

use spinoso_regexp::{Options, Source};

let source = Source::with_pattern_and_options(
    b"Artichoke( Ruby)?".to_vec(),
    Options::with_ignore_case(),
);
assert_eq!(source.options().as_display_modifier(), "i");

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Source

fn default() -> Source

Returns the “default value” for a type.

impl From<&Config> for Source

fn from(config: &Config) -> Self

Converts to this type from the input type.

impl From<&Source> for Config

fn from(source: &Source) -> Self

Converts to this type from the input type.

impl From<Config> for Source

fn from(config: Config) -> Self

Converts to this type from the input type.

impl From<Source> for Config

fn from(source: Source) -> Self

Converts to this type from the input type.

impl Hash for Source

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Source

fn cmp(&self, other: &Source) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Source

fn eq(&self, other: &Source) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Source

fn partial_cmp(&self, other: &Source) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Source

impl StructuralPartialEq for Source