Struct Matcher 

pub struct Matcher { /* private fields */ }

Match paths against include/exclude patterns, without watching anything.

This uses the same pattern syntax as Watcher (see Watcher::add_include), exposed for callers that receive paths from somewhere else - a single watcher covering many independently-configured subtrees, say - and need to decide for themselves which set of rules a path belongs to.

A pattern naming a directory covers everything inside it. For excludes this mirrors the watcher exactly: it never descends into an excluded directory, so nothing in there is ever reported. For includes this is slightly more lenient than the watcher’s event filter, which reports the named directory itself but requires dir/** to report its contents.

use include_exclude_watcher::Matcher;

let matcher = Matcher::new(&["**/*"], &["node_modules", "*.log"]);
assert!(matcher.matches("src/main.rs"));
assert!(!matcher.matches("node_modules/left-pad/index.js"));
assert!(!matcher.matches("var/app.log"));

Implementations

impl Matcher

pub fn new<I: AsRef<str>, E: AsRef<str>>(includes: &[I], excludes: &[E]) -> Self

Create a matcher from include and exclude patterns.

See Watcher::add_include for the pattern syntax.

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

Whether path matches at least one include pattern and no exclude pattern.

The path is interpreted like the watcher’s relative paths: /-separated, relative to whatever the patterns are anchored to.

Trait Implementations

impl Clone for Matcher

fn clone(&self) -> Matcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Matcher

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

Formats the value using the given formatter.