Struct Pattern

pub struct Pattern {
    pub text: BString,
    pub mode: Mode,
    pub first_wildcard_pos: Option<usize>,
}

A glob pattern optimized for matching paths relative to a root directory.

For normal globbing, use wildmatch() instead.

Fields

text: BString

the actual pattern bytes

mode: Mode

Additional information to help accelerate pattern matching.

first_wildcard_pos: Option<usize>

The position in text with the first wildcard character, or None if there is no wildcard at all.

Implementations

impl Pattern

Instantiation

pub fn from_bytes(text: &[u8]) -> Option<Self>

Parse the given text as pattern, or return None if text was empty.

pub fn from_bytes_without_negation(text: &[u8]) -> Option<Self>

Parse the given text as pattern without supporting leading ! or \\! , or return None if text was empty.

This assures that text remains entirely unaltered, but removes built-in support for negation as well.

impl Pattern

Access

pub fn is_negative(&self) -> bool

Return true if a match is negated.

pub fn matches_repo_relative_path( &self, path: &BStr, basename_start_pos: Option<usize>, is_dir: Option<bool>, case: Case, mode: Mode, ) -> bool

Match the given path which takes slashes (and only slashes) literally, and is relative to the repository root. Note that path is assumed to be relative to the repository.

We may take various shortcuts which is when basename_start_pos and is_dir come into play. basename_start_pos is the index at which the path’s basename starts.

case folding can be configured as well. mode is used to control how crate::wildmatch() should operate.

pub fn matches(&self, value: &BStr, mode: Mode) -> bool

See if value matches this pattern in the given mode.

mode can identify value as path which won’t match the slash character, and can match strings with cases ignored as well. Note that the case folding performed here is ASCII only.

Note that this method uses some shortcuts to accelerate simple patterns, but falls back to wildmatch() if these fail.

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<'de> Deserialize<'de> for Pattern

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pattern

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

Formats the value using the given formatter.

impl Hash for Pattern

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 Pattern

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Pattern

impl StructuralPartialEq for Pattern