Struct AsyncDebouncer

pub struct AsyncDebouncer<T: Watcher> { /* private fields */ }

Implementations

impl<T: Watcher> AsyncDebouncer<T>

pub async fn stop(self)

pub fn watcher(&mut self) -> &mut dyn Watcher

impl<T: Watcher> AsyncDebouncer<T>

pub async fn new_with_opts<F: AsyncDebounceEventHandler + Send + 'static>( timeout: Duration, tick_rate: Option<Duration>, event_handler: F, config: Config, ) -> Result<Self, Error>

Creates a new debounced watcher with custom configuration. The timeout specifies the amount of time that must elapse before an event is emitted, or a continuous event is sent (if there still are events incoming for the specific path). If tick_rate is set to None, then a tick rate will be selected that is less than the provided timeout.

pub async fn new_with_channel_and_opts<F: AsyncDebounceEventHandler + Send + 'static>( timeout: Duration, tick_rate: Option<Duration>, config: Config, ) -> Result<(Self, Receiver<Result<Vec<DebouncedEvent>, Vec<NotifyError>>>), Error>

Creates a new debounced watcher with custom configuration. The timeout specifies the amount of time that must elapse before an event is emitted, or a continuous event is sent (if there still are events incoming for the specific path). If tick_rate is set to None, then a tick rate will be selected that is less than the provided timeout. A handle to the debouncer is returned alongside a channel that can be used to receive events.

impl AsyncDebouncer<RecommendedWatcher>

pub async fn new<F: AsyncDebounceEventHandler + Send + 'static>( timeout: Duration, tick_rate: Option<Duration>, event_handler: F, ) -> Result<Self, Error>

Creates a new debounced watcher with the recommended watcher implementation. The timeout specifies the amount of time that must elapse before an event is emitted, or a continuous event is sent (if there still are events incoming for the specific path). If tick_rate is set to None, then a tick rate will be selected that is less than the provided timeout.

pub async fn new_with_channel( timeout: Duration, tick_rate: Option<Duration>, ) -> Result<(Self, Receiver<Result<Vec<DebouncedEvent>, Vec<NotifyError>>>), Error>

Creates a new debounced watcher with the recommended watcher implementation. The timeout specifies the amount of time that must elapse before an event is emitted, or a continuous event is sent (if there still are events incoming for the specific path). If tick_rate is set to None, then a tick rate will be selected that is less than the provided timeout. A handle to the debouncer is returned alongside a channel that can be used to receive events.

Trait Implementations

impl<T: Watcher> Drop for AsyncDebouncer<T>

fn drop(&mut self)

Executes the destructor for this type.