Struct git_attributes::MatchGroup

pub struct MatchGroup<T: Pattern = Attributes> {
    pub patterns: Vec<PatternList<T>>,
}

A grouping of lists of patterns while possibly keeping associated to their base path.

Pattern lists with base path are queryable relative to that base, otherwise they are relative to the repository root.

Fields

patterns: Vec<PatternList<T>>

A list of pattern lists, each representing a patterns from a file or specified by hand, in the order they were specified in.

During matching, this order is reversed.

Implementations

impl<T> MatchGroup<T> where
    T: Pattern, 

pub fn pattern_matching_relative_path<'a>(
    &self,
    relative_path: impl Into<&'a BStr>,
    is_dir: Option<bool>,
    case: Case
) -> Option<Match<'_, T::Value>>

Match relative_path, a path relative to the repository containing all patterns, and return the first match if available.

impl MatchGroup<Ignore>

pub fn from_git_dir(
    git_dir: impl AsRef<Path>,
    excludes_file: Option<PathBuf>,
    buf: &mut Vec<u8>
) -> Result<Self>

Given git_dir, a .git repository, load ignore patterns from info/exclude and from excludes_file if it is provided. Note that it’s not considered an error if the provided excludes_file does not exist.

pub fn from_overrides(
    patterns: impl IntoIterator<Item = impl Into<OsString>>
) -> Self

See PatternList::::from_overrides() for details.

pub fn add_patterns_file(
    &mut self,
    source: impl Into<PathBuf>,
    follow_symlinks: bool,
    root: Option<&Path>,
    buf: &mut Vec<u8>
) -> Result<bool>

Add the given file at source if it exists, otherwise do nothing. If a root is provided, it’s not considered a global file anymore. Returns true if the file was added, or false if it didn’t exist.

pub fn add_patterns_buffer(
    &mut self,
    bytes: &[u8],
    source: impl Into<PathBuf>,
    root: Option<&Path>
)

Add patterns as parsed from bytes, providing their source path and possibly their root path, the path they are relative to. This also means that source is contained within root if root is provided.

Trait Implementations

impl<T: Clone + Pattern> Clone for MatchGroup<T>

fn clone(&self) -> MatchGroup<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Pattern> Debug for MatchGroup<T>

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

Formats the value using the given formatter.

impl<T: Default + Pattern> Default for MatchGroup<T>

fn default() -> MatchGroup<T>

Returns the “default value” for a type.

impl<T: Hash + Pattern> Hash for MatchGroup<T>

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<T: Ord + Pattern> Ord for MatchGroup<T>

fn cmp(&self, other: &MatchGroup<T>) -> 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 where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl<T: PartialEq + Pattern> PartialEq<MatchGroup<T>> for MatchGroup<T>

fn eq(&self, other: &MatchGroup<T>) -> 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<T: PartialOrd + Pattern> PartialOrd<MatchGroup<T>> for MatchGroup<T>

fn partial_cmp(&self, other: &MatchGroup<T>) -> 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<T: Eq + Pattern> Eq for MatchGroup<T>

impl<T: Pattern> StructuralEq for MatchGroup<T>

impl<T: Pattern> StructuralPartialEq for MatchGroup<T>