Enum notify::Config[−][src]

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

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[src]

fn clone(&self) -> Config[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Config[src]

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

Formats the value using the given formatter. Read more

impl PartialEq<Config> for Config[src]

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

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

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

This method tests for !=.

impl Eq for Config[src]

impl StructuralEq for Config[src]

impl StructuralPartialEq for Config[src]

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.