Enum StringPattern

pub enum StringPattern {
    Exact(String),
    ExactI(String),
    Substring(String),
    SubstringI(String),
    Glob(GlobPattern),
    GlobI(GlobPattern),
    Regex(Regex),
    RegexI(Regex),
}

Pattern to be tested against string property like commit description or bookmark name.

Variants

Exact(String)

Matches strings exactly.

ExactI(String)

Matches strings case‐insensitively.

Substring(String)

Matches strings that contain a substring.

SubstringI(String)

Matches strings that case‐insensitively contain a substring.

Glob(GlobPattern)

Matches with a Unix‐style shell wildcard pattern.

GlobI(GlobPattern)

Matches with a case‐insensitive Unix‐style shell wildcard pattern.

Regex(Regex)

Matches substrings with a regular expression.

RegexI(Regex)

Matches substrings with a case‐insensitive regular expression.

Implementations

impl StringPattern

pub const fn everything() -> Self

Pattern that matches any string.

pub fn parse(src: &str) -> Result<StringPattern, StringPatternParseError>

Parses the given string as a StringPattern. Everything before the first “:” is considered the string’s prefix. If the prefix is “exact[-i]:”, “glob[-i]:”, or “substring[-i]:”, a pattern of the specified kind is returned. Returns an error if the string has an unrecognized prefix. Otherwise, a StringPattern::Exact is returned.

pub fn exact(src: impl Into<String>) -> Self

Constructs a pattern that matches exactly.

pub fn exact_i(src: impl Into<String>) -> Self

Constructs a pattern that matches case‐insensitively.

pub fn substring(src: impl Into<String>) -> Self

Constructs a pattern that matches a substring.

pub fn substring_i(src: impl Into<String>) -> Self

Constructs a pattern that case‐insensitively matches a substring.

pub fn glob(src: &str) -> Result<Self, StringPatternParseError>

Parses the given string as a glob pattern.

pub fn glob_i(src: &str) -> Result<Self, StringPatternParseError>

Parses the given string as a case‐insensitive glob pattern.

pub fn regex(src: &str) -> Result<Self, StringPatternParseError>

Parses the given string as a regular expression.

pub fn regex_i(src: &str) -> Result<Self, StringPatternParseError>

Parses the given string as a case-insensitive regular expression.

pub fn from_str_kind( src: &str, kind: &str, ) -> Result<Self, StringPatternParseError>

Parses the given string as a pattern of the specified kind.

pub fn is_exact(&self) -> bool

Returns true if this pattern matches input strings exactly.

pub fn as_exact(&self) -> Option<&str>

Returns a literal pattern if this should match input strings exactly.

This can be used to optimize map lookup by exact key.

pub fn as_str(&self) -> &str

Returns the original string of this pattern.

pub fn to_glob(&self) -> Option<Cow<'_, str>>

Converts this pattern to a glob string. Returns None if the pattern can’t be represented as a glob.

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

Returns true if this pattern matches the haystack.

When matching against a case‐insensitive pattern, only ASCII case differences are currently folded. This may change in the future.

pub fn filter_btree_map<'a, 'b, K: Borrow<str> + Ord, V>( &'b self, map: &'a BTreeMap<K, V>, ) -> impl Iterator<Item = (&'a K, &'a V)> + use<'a, 'b, K, V>

Iterates entries of the given map whose string keys match this pattern.

pub fn filter_btree_map_as_deref<'a, 'b, K, V>( &'b self, map: &'a BTreeMap<K, V>, ) -> impl Iterator<Item = (&'a K, &'a V)> + use<'a, 'b, K, V>

where K: Borrow<K::Target> + Deref + Ord, K::Target: AsRef<str> + Ord, str: AsRef<K::Target>,

Iterates entries of the given map whose string-like keys match this pattern.

The borrowed key type is constrained by the Deref::Target. It must be convertible to/from str.

Trait Implementations

impl Clone for StringPattern

fn clone(&self) -> StringPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringPattern

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

Formats the value using the given formatter.

impl Display for StringPattern

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

Shows the original string of this pattern.