Struct arti::reload_cfg::FileWatcherBuilder

struct FileWatcherBuilder {
    watching_dirs: HashSet<PathBuf>,
    watching_files: HashSet<PathBuf>,
}

Available on crate feature experimental-api only.

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

Fields

watching_dirs: HashSet<PathBuf>

The list of directories that we’re currently watching.

watching_files: HashSet<PathBuf>

The list of files we actually care about.

Implementations

impl FileWatcherBuilder

fn new() -> Self

Create a FileWatcherBuilder

fn prepare<'a>(
    &mut self,
    sources: &'a ConfigurationSources
) -> Result<FoundConfigFiles<'a>>

Find the configuration files and prepare the watcher

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

Add a single file (not a directory) to the list of things to watch.

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

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

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

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)

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

Does not watch any of the parents.

Idempotent.

fn start_watching(self, tx: Sender<Event>) -> Result<FileWatcher>

Build a FileWatcher and start sending events to tx.

For the watching to be reliably effective (race-free), the config must be read after this point, using the FoundConfigFiles returned by prepare.