Struct Pattern

pub struct Pattern {
    pub signature: MagicSignature,
    pub search_mode: SearchMode,
    pub attributes: Vec<Assignment>,
    /* private fields */
}

The output of a pathspec parsing operation. It can be used to match against a one or more paths.

Fields

signature: MagicSignature

All magic signatures that were included in the pathspec.

search_mode: SearchMode

The search mode of the pathspec.

attributes: Vec<Assignment>

All attributes that were included in the ATTR part of the pathspec, if present.

:(attr:a=one b=):path would yield attribute a and b.

Implementations

impl Pattern

Access

pub fn is_nil(&self) -> bool

Returns true if this seems to be a pathspec that indicates that ‘there is no pathspec’.

Note that such a spec is :.

pub fn prefix_directory(&self) -> &BStr

Return the prefix-portion of the path of this spec, which is a directory. It can be empty if there is no prefix.

A prefix is effectively the CWD seen as relative to the working tree, and it’s assumed to match case-sensitively. This makes it useful for skipping over large portions of input by directly comparing them.

pub fn path(&self) -> &BStr

Return the path of this spec, typically used for matching.

impl Pattern

Mutation

pub fn normalize( &mut self, prefix: &Path, root: &Path, ) -> Result<&mut Self, Error>

Normalize the pattern’s path by assuring it’s relative to the root of the working tree, and contains no relative path components. Further, it assures that / are used as path separator.

If self.path is a relative path, it will be put in front of the pattern path if self.signature isn’t indicating TOP already. If self.path is an absolute path, we will use root to make it worktree relative if possible.

prefix can be empty, we will still normalize this pathspec to resolve relative path components, and it is assumed not to contain any relative path components, e.g. ‘’, ‘a’, ‘a/b’ are valid. root is the absolute path to the root of either the worktree or the repository’s git_dir.

impl Pattern

Access

pub fn is_excluded(&self) -> bool

Return true if this pathspec is negated, which means it will exclude an item from the result set instead of including it.

pub fn always_matches(&self) -> bool

Returns true is this pattern is supposed to always match, as it’s either empty or designated nil. Note that technically the pattern might still be excluded.

pub fn to_bstring(&self) -> BString

Translate ourselves to a long display format, that when parsed back will yield the same pattern.

Note that the

impl Pattern

pub fn from_bytes(input: &[u8], _: Defaults) -> Result<Self, Error>

Try to parse a path-spec pattern from the given input bytes.

pub fn from_literal(input: &[u8], default_signature: MagicSignature) -> Self

Take input literally without parsing anything. This will also set our mode to literal to allow this pathspec to match input verbatim, and use default_signature as magic signature.

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 Default for Pattern

fn default() -> Pattern

Returns the “default value” for a type.

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 Eq for Pattern

impl StructuralPartialEq for Pattern