Struct Pattern

pub struct Pattern { /* private fields */ }

A user pattern compiled to the regular-expression substrate used by every matcher.

Patterns match a complete candidate. Use ** in a glob or .* in a regular expression when a prefix or suffix is intentionally unconstrained.

Implementations

impl Pattern

pub fn glob(glob: impl AsRef<str>) -> Result<Self, PatternError>

Compiles a portable, case-sensitive glob.

The supported wildcards are *, **, ?, character classes such as [abc] and [a-z], and negated character classes such as [!0-9]. Backslashes are path separators rather than escapes so one glob behaves the same on every host OS.

pub fn glob_with( glob: impl AsRef<str>, options: PatternOptions, ) -> Result<Self, PatternError>

Compiles a glob with explicit options.

pub fn regex(expression: impl AsRef<str>) -> Result<Self, PatternError>

Compiles a regular expression with complete-candidate matching.

pub fn regex_with( expression: impl AsRef<str>, options: PatternOptions, ) -> Result<Self, PatternError>

Compiles a regular expression with explicit options.

pub fn literal(literal: impl AsRef<str>) -> Result<Self, PatternError>

Compiles a complete literal string, including characters meaningful to globs and regexes.

pub fn literal_with( literal: impl AsRef<str>, options: PatternOptions, ) -> Result<Self, PatternError>

Compiles a complete literal string with explicit options.

pub fn source(&self) -> &str

Returns the pattern exactly as the user supplied it.

pub const fn syntax(&self) -> PatternSyntax

Returns whether this pattern originated as a glob or a regular expression.

pub fn matches(&self, candidate: &str) -> bool

Returns whether the complete normalized candidate matches.

pub fn replace(&self, candidate: &str, replacement: &str) -> String

Replaces this pattern’s match in a normalized candidate.

Rust regex replacement syntax is supported, including $1 and ${name} captures. Because every Pattern is anchored, a matching replacement always covers the complete candidate.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl Display for Pattern

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

Formats the value using the given formatter.