Struct Config

pub struct Config { /* private fields */ }

A Config represents the parsed, expanded, and normalized pattern and options used to initialize a Regexp.

A Config is derived from a Source.

When a Regexp is cloned, it is cloned from its compiled Config.

Implementations

impl Config

pub const fn new() -> Self

Construct a new, empty Config.

Examples

use spinoso_regexp::Config;

const CONFIG: Config = Config::new();
assert!(CONFIG.pattern().is_empty());
assert!(CONFIG.options().as_display_modifier().is_empty());

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

Construct a new Config with the given pattern and Options.

Examples

use spinoso_regexp::{Config, Options};

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

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

Extracts a slice containing the entire pattern.

Examples

use spinoso_regexp::{Config, Options};

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

pub const fn options(&self) -> Options

Return a copy of the underlying Options.

Examples

use spinoso_regexp::{Config, Options};

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

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 Config

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 Config

fn cmp(&self, other: &Config) -> 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 Config

fn eq(&self, other: &Config) -> 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 Config

fn partial_cmp(&self, other: &Config) -> 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 Config

impl StructuralPartialEq for Config