Struct NotifyWatcher 

pub struct NotifyWatcher { /* private fields */ }

File watcher backed by the notify crate.

Wraps a RecommendedWatcher and exposes watch/unwatch methods. Events are sent to the unbounded receiver returned by NotifyWatcher::new.

Implementations

impl NotifyWatcher

pub fn new( ignore: Arc<IgnoreFilter>, ) -> Result<(Self, UnboundedReceiver<WatchEvent>)>

Create a new watcher with the given ignore filter.

Returns the watcher and an unbounded receiver of WatchEvents. The receiver should be fed into a SettleBuffer.

Errors

Returns an error if the OS file watcher cannot be initialized.

pub fn watch(&mut self, path: &Path) -> Result<()>

Start watching a single directory (non-recursive).

Callers are responsible for enumerating subdirectories and watching each one individually. This avoids platform-level recursive watches that can hit OS limits or produce degenerate behaviour on large trees.

Errors

Returns an error if the path cannot be watched.

pub fn watch_recursive(&mut self, path: &Path) -> Result<()>

Start watching a directory recursively.

This is intended for library consumers that want a single root watch.

Errors

Returns an error if the path cannot be watched.

pub fn unwatch(&mut self, path: &Path) -> Result<()>

Stop watching a directory.

Errors

Returns an error if the path was not being watched.

Trait Implementations

impl Debug for NotifyWatcher

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

Formats the value using the given formatter.