Struct IgnorePatternSet 

pub struct IgnorePatternSet { /* private fields */ }

The discovery ignore set with its ! exceptions.

matches_into and len read only the ignore globs, in the index layout that crate::DEFAULT_IGNORE_PATTERNS documents. is_match applies the exceptions too, so every caller that asks “is this path ignored” gets the same answer.

Implementations

impl IgnorePatternSet

pub fn empty() -> Self

A set that ignores nothing.

pub fn new(patterns: GlobSet, exception_bodies: &[&str]) -> Self

Build a set from ignore globs and ! exception bodies (without the !). Exception bodies that do not compile are dropped, because config load validates them first.

pub fn is_match(&self, path: impl AsRef<Path>) -> bool

True when the path is ignored: an ignore glob matches it and no ! exception lifts it.

pub fn matches_into(&self, path: impl AsRef<Path>, into: &mut Vec<usize>)

Indices of the ignore globs that match the path, without the exceptions. Callers use it only for a path that is_match rejected.

pub fn matches(&self, path: impl AsRef<Path>) -> Vec<usize>

Indices of the ignore globs that match the path, without the exceptions.

pub fn len(&self) -> usize

Number of ignore globs, without the exceptions.

pub fn is_empty(&self) -> bool

True when the set has no ignore globs.

pub fn has_exceptions(&self) -> bool

True when the project wrote at least one ! exception.

pub fn is_lifted(&self, path: impl AsRef<Path>) -> bool

True when a ! exception matches the path and the path is not under node_modules or .git.

pub fn admits_hidden_dir(&self, dir: &Path) -> bool

True when the walk must open the hidden directory dir (a path relative to the project root) because a ! exception can match a file inside it. The walk keeps only the files that an exception matches.

Trait Implementations

impl Clone for IgnorePatternSet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IgnorePatternSet

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

Formats the value using the given formatter.

impl Default for IgnorePatternSet

fn default() -> Self

Returns the “default value” for a type.

impl From<GlobSet> for IgnorePatternSet

fn from(patterns: GlobSet) -> Self

Converts to this type from the input type.