Enum notify::Config

pub enum Config {
    PreciseEvents(bool),
    NoticeEvents(bool),
    OngoingEvents(Option<Duration>),
}

Runtime configuration items for watchers.

See the Watcher::configure method for usage.

Variants

PreciseEvents(bool)

Enable or disable emitting precise event classification.

Applicable to all watchers.

When enabled, events are emitted with a kind set to as much precision about what kind of event they are as the backend is capable of providing. When disabled (default), events are instead emitted as EventKind::Any. EventKind::Other meta-events are left alone.

NoticeEvents(bool)

Enable or disable emitting Notice events.

Applicable to debounced watchers only.

When enabled, the first modify or remove event for a path is emitted immediately with a Flag::Notice attribute within a debouncing period, enabling applications to respond more quickly.

OngoingEvents(Option<Duration>)

Enable or disable emitting Ongoing events.

Applicable to debounced watchers only.

When enabled, partial write events that are received after a Modify(Data) Notice but before the end of a debouncing period (and the emission of a Modify(Data) event) are passed through as Modify(Data) events with an Ongoing flag. These events are still debounced, but at a lower (configurable) interval than the debouncing interval.

To enable, provide Some(Duration). To disable, provide None.

Errors

• InvalidConfigValue if the interval provided is higher than the debounce interval.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config