Trait Watcher

trait Watcher

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<F: EventHandler>(event_handler: F, config: config::Config) -> Result<Self>
where
    Self: Sized

Create a new watcher with an initial Config.

fn watch(self: &mut Self, path: &Path, recursive_mode: RecursiveMode) -> Result<()>

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.

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

Stop watching a path.

Errors

Returns an error in the case that path has not been watched or if removing the watch fails.

fn kind() -> WatcherKind
where
    Self: Sized

Returns the watcher kind, allowing to perform backend-specific tasks

Provided Methods

fn paths_mut<'me>(self: &'me mut Self) -> Box<dyn PathsMut + 'me>

Add/remove paths to watch.

For some watcher implementations this method provides better performance than multiple calls to Watcher::watch and Watcher::unwatch if you want to add/remove many paths at once.

Examples

# use notify::{Watcher, RecursiveMode, Result};
# use std::path::Path;
# fn main() -> Result<()> {
# let many_paths_to_add = vec![];
let mut watcher = notify::recommended_watcher(|_event| { /* event handler */ })?;
let mut watcher_paths = watcher.paths_mut();
for path in many_paths_to_add {
    watcher_paths.add(path, RecursiveMode::Recursive)?;
}
watcher_paths.commit()?;
# Ok(())
# }

fn configure(self: &mut Self, _option: Config) -> Result<bool>

Configure the watcher at runtime.

See the Config struct for all configuration options.

Returns

  • Ok(true) on success.
  • Ok(false) if the watcher does not support or implement the option.
  • Err(notify::Error) on failure.

Implementors