Struct ignore::overrides::Override

pub struct Override(_);

Manages a set of overrides provided explicitly by the end user.

Methods

impl Override

pub fn empty() -> Override

Returns an empty matcher that never matches any file path.

pub fn path(&self) -> &Path

Returns the directory of this override set.

All matches are done relative to this path.

pub fn is_empty(&self) -> bool

Returns true if and only if this matcher is empty.

When a matcher is empty, it will never match any file path.

pub fn num_ignores(&self) -> u64

Returns the total number of ignore globs.

pub fn num_whitelists(&self) -> u64

Returns the total number of whitelisted globs.

pub fn matched<'a, P: AsRef<Path>>(
    &'a self,
    path: P,
    is_dir: bool
) -> Match<Glob<'a>>

Returns whether the given file path matched a pattern in this override matcher.

is_dir should be true if the path refers to a directory and false otherwise.

If there are no overrides, then this always returns Match::None.

If there is at least one whitelist override and is_dir is false, then this never returns Match::None, since non-matches are interpreted as ignored.

The given path is matched to the globs relative to the path given when building the override matcher. Specifically, before matching path, its prefix (as determined by a common suffix of the directory given) is stripped. If there is no common suffix/prefix overlap, then path is assumed to reside in the same directory as the root path for this set of overrides.

Trait Implementations

impl Clone for Override

fn clone(&self) -> Override

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Override

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

Formats the value using the given formatter.