Struct watchexec::ignore::IgnoreFilterer

pub struct IgnoreFilterer { /* private fields */ }

A path-only filterer dedicated to 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).

It implements Filterer so it can be used directly in another filterer; it is not designed to be used as a standalone filterer.

Implementations

impl IgnoreFilterer

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>,
    files: &[IgnoreFile]
) -> Result<Self, RuntimeError>

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<(), RuntimeError>

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

Does nothing silently otherwise.

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

Adds some globs manually, if the builder is available.

Does nothing silently otherwise.

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 the Filterer trait, as the latter handles events with multiple associated paths.

Trait Implementations

impl Clone for IgnoreFilterer

fn clone(&self) -> IgnoreFilterer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IgnoreFilterer

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

Formats the value using the given formatter.

impl Filterer for IgnoreFilterer

fn check_event(&self, event: &Event) -> Result<bool, RuntimeError>

Filter an event.

This implementation never errors. It returns Ok(false) if the event is ignored according to the ignore files, and Ok(true) otherwise.