Struct IgnorePatterns 

pub struct IgnorePatterns { /* private fields */ }

Gitignore-style patterns, read from files, which exclude entries from a traversal.

Patterns are matched against the path dua reports for an entry: normally relative to its effective working directory, or relative to an input root outside that directory. So target/ excludes directories named target at any depth, while /target/ excludes only target at the traversal root of that relative path, exactly like a .gitignore at the top of a repository.

Matching is case-sensitive on every platform so that the same pattern file produces the same report everywhere.

Implementations

impl IgnorePatterns

pub fn from_files(files: &[PathBuf]) -> Result<Option<Self>>

Read gitignore-style patterns from each file in files, in the given order.

The usual .gitignore precedence applies: within a file the last matching line wins, and files listed later win over files listed earlier. Reading a file that does not exist, or that cannot be read, is an error - a silently empty pattern set would quietly report sizes the caller did not ask for.

pub fn is_excluded(&self, relative_path: &Path, is_dir: bool) -> bool

Return true if relative_path is excluded, with is_dir telling directories from files so that patterns ending in / only match directories.

Note that callers are expected to stop descending into excluded directories, which also means a negated pattern cannot bring back an entry below an excluded directory - the same restriction Git has.

pub fn excludes_input_path(&self, path: &Path, cwd: &Path) -> bool

Return true if the input path is excluded, resolving it the way the traversal does. These are made relative to cwd.

Input paths that are excluded are best dropped before the walk starts, or they would be reported as being empty rather than not reported at all.

Trait Implementations

impl Clone for IgnorePatterns

fn clone(&self) -> IgnorePatterns

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IgnorePatterns

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

Formats the value using the given formatter.