Struct IgnoreFilter

pub struct IgnoreFilter { /* private fields */ }

A mutable filter dedicated to ignore files and trees of ignore files.

This reads and compiles ignore files, and should be used for handling ignore files. It’s created with a project origin and a list of ignore files, and new ignore files can be added later (unless finish is called).

Implementations

impl IgnoreFilter

pub fn empty(origin: impl AsRef<Path>) -> Self

Create a new empty filterer.

Prefer new() if you have ignore files ready to use.

pub async fn new( origin: impl AsRef<Path> + Send, files: &[IgnoreFile], ) -> Result<Self, Error>

Read ignore files from disk and load them for filtering.

Use empty() if you want an empty filterer, or to construct one outside an async environment.

pub fn num_ignores(&self) -> (u64, u64)

Returns the number of ignores and allowlists loaded.

pub fn finish(&mut self)

Deletes the internal builder, to save memory.

This makes it impossible to add new ignore files without re-compiling the whole set.

pub async fn add_file(&mut self, file: &IgnoreFile) -> Result<(), Error>

Reads and adds an ignore file, if the builder is available.

Does nothing silently otherwise.

pub fn add_globs( &mut self, globs: &[&str], applies_in: Option<&PathBuf>, ) -> Result<(), Error>

Adds some globs manually, if the builder is available.

Does nothing silently otherwise.

pub fn match_path(&self, path: &Path, is_dir: bool) -> Match<&Glob>

Match a particular path against the ignore set.

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

Check a particular folder path against the ignore set.

Returns false if the folder should be ignored.

Note that this is a slightly different implementation than watchexec’s Filterer trait, as the latter handles events with multiple associated paths.

Trait Implementations

impl Clone for IgnoreFilter

fn clone(&self) -> IgnoreFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IgnoreFilter

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

Formats the value using the given formatter.