Struct Search

pub struct Search {
    pub patterns: Vec<List<Ignore>>,
}

A grouping of lists of patterns while possibly keeping associated to their base path in order to find matches.

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

Fields

patterns: Vec<List<Ignore>>

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

When matching, this order is reversed.

Implementations

impl Search

Instantiation of a search for ignore patterns.

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

Given git_dir, a .git repository, load static 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

Parse a list of ignore patterns, using slashes as path separators.

impl Search

Mutation

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.

impl Search

Matching of ignore patterns.

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

Match relative_path and return the first match if found. is_dir is true if relative_path is a directory. case specifies whether cases should be folded during matching or not.

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Search

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

Formats the value using the given formatter.

impl Default for Search

fn default() -> Search

Returns the “default value” for a type.

impl Hash for Search

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 Search

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

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

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

impl StructuralPartialEq for Search