struct FileWatcher {
    _watcher: RecommendedWatcher,
}
Available on crate feature experimental-api only.
Expand description

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

The wrapper contains the Watcher and also the channel for receiving events.

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.

TODO: Someday we might want to make this code exported someplace. If we do, we should test it, and improve its API a lot. Right now, the caller needs to mess around with std::sync::mpsc and filter out the events they want using FileWatcher::event_matched.

Fields

_watcher: RecommendedWatcher

An underlying notify watcher that tells us about directory changes.

Implementations

Create a FileWatcherBuilder

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more