Struct FileWatcher

pub struct FileWatcher { /* private fields */ }

A wrapper around a notify::Watcher to watch a set of parent directories in order to learn about changes in some specific files that they contain.

The Watcher implementation in notify has a weakness: it gives sensible results when you’re watching directories, but if you start watching non-directory files, it won’t notice when those files get replaced. That’s a problem for users who want to change their configuration atomically by making new files and then moving them into place over the old ones.

For more background on the issues with notify, see https://github.com/notify-rs/notify/issues/165 and https://github.com/notify-rs/notify/pull/166.

Limitations

On backends using kqueue, this uses a polling watcher to work around a bug in the notify crate¹. This introduces a perceivable delay, and can be very expensive for large file trees.

---

1. See https://github.com/notify-rs/notify/issues/644 ↩

Implementations

impl FileWatcher

pub fn watching_dirs(&self) -> &HashSet<PathBuf>

Method borrowing FileWatcher::watching_dirs field. The list of directories that we’re currently watching.

impl FileWatcher

pub fn builder<R: Runtime>(runtime: R) -> FileWatcherBuilder<R>

Create a FileWatcherBuilder