Struct FileWatcherBuilder 

pub struct FileWatcherBuilder<R: Runtime> {
    runtime: PhantomData<R>,
    watching_dirs: HashMap<PathBuf, HashSet<DirEventFilter>>,
}

Builder used to configure a FileWatcher before it starts watching for changes.

Fields

runtime: PhantomData<R>

The runtime. We used to use this.

TODO get rid of this, but after we decide whether to keep using postage::watch. See the Warning note on Event.

watching_dirs: HashMap<PathBuf, HashSet<DirEventFilter>>

The list of directories that we’re currently watching.

Each directory has a set of filters that indicates whether a given notify::Event is relevant or not.

Implementations

impl<R: Runtime> FileWatcherBuilder<R>

pub fn new(_runtime: R) -> Self

Create a FileWatcherBuilder

pub fn watch_path<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Add a single path to the list of things to watch.

The event receiver will be notified if the path is created, modified, renamed, or removed.

If the path is a directory, its contents will not be watched. To watch the contents of a directory, use watch_dir.

Idempotent: does nothing if we’re already watching that path.

pub fn watch_dir<P: AsRef<Path>, S: AsRef<str>>( &mut self, path: P, extension: S, ) -> Result<()>

Add a directory (but not any subdirs) to the list of things to watch.

The event receiver will be notified whenever a file with the specified extension is created within this directory, or if an existing file with this extension is modified, renamed, or removed. Changes to files that have a different extension are ignored.

Idempotent.

fn watch_just_parents(&mut self, path: &Path) -> Result<PathBuf>

Add the parents of path to the list of things to watch.

Returns the absolute path of path.

Idempotent.

fn watch_just_abs_dir(&mut self, watch_target: &Path, filter: DirEventFilter)

Add just this (absolute) directory to the list of things to watch.

Does not watch any of the parents.

Idempotent.

pub fn start_watching(self, tx: FileEventSender) -> Result<FileWatcher>

Build a FileWatcher and start sending events to tx.

On startup, the watcher sends a Rescan event. This helps mitigate the event loss that occurs if the watched files are modified between the time they are initially loaded and the time when the watcher is set up.