Struct FileWatcher

pub struct FileWatcher { /* private fields */ }

Wrapper around a notify::Watcher. It runs the inner watcher in a separate thread, and communicates with it via an mpsc::channel.

Implementations

impl FileWatcher

pub fn new<T: Notify + 'static>(peer: T) -> Self

pub fn watch(&mut self, path: &Path, recursive: bool, token: WatchToken)

Begin watching path. As DebouncedEvents (documented in the notify crate) arrive, they are stored with the associated token and a task is added to the runloop’s idle queue.

Delivery of events then requires that the runloop’s handler correctly forward the handle_idle call to the interested party.

pub fn watch_filtered<F>( &mut self, path: &Path, recursive: bool, token: WatchToken, filter: F, )

where F: Fn(&Path) -> bool + Send + 'static,

Like watch, but taking a predicate function that filters delivery of events based on their path.

pub fn unwatch(&mut self, path: &Path, token: WatchToken)

Removes the provided token/path pair from the watch list. Does not stop watching this path, if it is associated with other tokens.

pub fn take_events(&mut self) -> VecDeque<(WatchToken, DebouncedEvent)>

Takes ownership of this Watcher’s current event queue.