Struct Search

pub struct Search { /* private fields */ }

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.

Implementations

impl Search

Instantiation and initialization.

pub fn new_globals( files: impl IntoIterator<Item = impl Into<PathBuf>>, buf: &mut Vec<u8>, collection: &mut MetadataCollection, ) -> Result<Self>

Create a search instance preloaded with built-ins followed by attribute files from various global locations.

See Source for a way to obtain these paths.

Note that parsing is lenient and errors are logged.

• buf is used to read files from disk which will be ignored if they do not exist.
• collection will be updated with information necessary to perform lookups later.

impl Search

Mutation

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

Add the given file at source to our patterns if it exists, otherwise do nothing. Update collection with newly added attribute names. If a root is provided, it’s not considered a global file anymore. If allow_macros is true, macros will be processed like normal, otherwise they will be skipped entirely. Returns true if the file was added, or false if it didn’t exist.

pub fn add_patterns_buffer( &mut self, bytes: &[u8], source: PathBuf, root: Option<&Path>, collection: &mut MetadataCollection, allow_macros: bool, )

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. If allow_macros is true, macros will be processed like normal, otherwise they will be skipped entirely.

pub fn pop_pattern_list(&mut self) -> Option<List<Attributes>>

Pop the last attribute patterns list from our queue.

impl Search

Access and matching

pub fn pattern_matching_relative_path( &self, relative_path: &BStr, case: Case, is_dir: Option<bool>, out: &mut Outcome, ) -> bool

Match relative_path, a path relative to the repository, while respective case-sensitivity and write them to out Return true if at least one pattern matched.

pub fn num_pattern_lists(&self) -> usize

Return the amount of pattern lists contained in this instance.

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