Trait notify::Watcher [−][src]
pub trait Watcher: Sized { fn new_immediate<F>(event_fn: F) -> Result<Self>
where
F: EventFn; fn watch<P: AsRef<Path>>(
&mut self,
path: P,
recursive_mode: RecursiveMode
) -> Result<()>; fn unwatch<P: AsRef<Path>>(&mut self, path: P) -> Result<()>; fn configure(&mut self, _option: Config) -> Result<bool> { ... } }
Expand description
Type that can deliver file activity notifications
Watcher is implemented per platform using the best implementation available on that platform. In addition to such event driven implementations, a polling implementation is also provided that should work on any platform.
Required methods
fn new_immediate<F>(event_fn: F) -> Result<Self> where
F: EventFn,
[src]
fn new_immediate<F>(event_fn: F) -> Result<Self> where
F: EventFn,
[src]Create a new watcher in immediate mode.
Events will be sent using the provided tx
immediately after they occur.
Begin watching a new path.
If the path
is a directory, recursive_mode
will be evaluated. If recursive_mode
is
RecursiveMode::Recursive
events will be delivered for all files in that tree. Otherwise
only the directory and its immediate children will be watched.
If the path
is a file, recursive_mode
will be ignored and events will be delivered only
for the file.
On some platforms, if the path
is renamed or removed while being watched, behaviour may
be unexpected. See discussions in #165 and #166. If less surprising behaviour is wanted
one may non-recursively watch the parent directory as well and manage related events.