Enum jj_lib::str_util::StringPattern

pub enum StringPattern {
    Exact(String),
    Glob(Pattern),
    Substring(String),
}

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

Variants

Exact(String)

Matches strings exactly equal to string.

Glob(Pattern)

Unix-style shell wildcard pattern.

Substring(String)

Matches strings that contain substring.

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:”, “glob:”, or “substring:”, 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

Creates pattern that matches exactly.

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

Parses the given string as glob pattern.

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

Parses the given string as 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.

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

Iterates entries of the given map whose keys matches this pattern.

Trait Implementations

impl Clone for StringPattern

fn clone(&self) -> StringPattern

Returns a copy 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.

impl PartialEq for StringPattern

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for StringPattern

impl StructuralPartialEq for StringPattern