Struct git_glob::Pattern

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

A glob pattern at a particular base path.

This closely models how patterns appear in a directory hierarchy of include or attribute files.

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.

base_path: Option<BString>

The relative base at which this pattern resides, with trailing slash, using slashes as path separator. If None, the pattern is considered to be at the root of the repository.

Implementations

impl Pattern

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

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

pub fn is_negative(&self) -> bool

Return true if a match is negated.

pub fn with_base(self, path: impl Into<BString>) -> Self

Set the base path of the pattern. Must be a slash-separated relative path with a trailing slash.

Use this upon creation of the pattern when the source file is known.

pub fn matches_repo_relative_path<'a>(
    &self,
    path: impl Into<&'a BStr>,
    basename_start_pos: Option<usize>,
    is_dir: bool,
    case: Case
) -> 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, and that our base_path is assumed to contain path.

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.

Lastly, case folding can be configured as well.

Note that this method uses shortcuts to accelerate simple patterns.

pub fn matches<'a>(&self, value: impl Into<&'a 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.

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 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, 

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

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Pattern> for Pattern

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

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

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

This method tests for !=.

impl PartialOrd<Pattern> 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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Pattern

impl StructuralEq for Pattern

impl StructuralPartialEq for Pattern