#events #notify #watch

notify-debouncer-mini

notify mini debouncer for events

9 unstable releases (3 breaking)

0.4.1 Aug 21, 2023
0.4.0 Aug 20, 2023
0.3.0 May 17, 2023
0.2.1 Sep 4, 2022
0.1.3 Aug 17, 2022

#111 in Filesystem

Download history 27429/week @ 2023-08-15 28412/week @ 2023-08-22 27100/week @ 2023-08-29 25690/week @ 2023-09-05 22945/week @ 2023-09-12 24654/week @ 2023-09-19 28189/week @ 2023-09-26 25281/week @ 2023-10-03 27169/week @ 2023-10-10 29695/week @ 2023-10-17 30043/week @ 2023-10-24 30170/week @ 2023-10-31 26467/week @ 2023-11-07 35148/week @ 2023-11-14 28907/week @ 2023-11-21 27807/week @ 2023-11-28

123,184 downloads per month
Used in 49 crates (40 directly)

MIT/Apache

185KB
3K SLoC

Notify debouncer

» Docs

Tiny debouncer for notify. Filters incoming events and emits only one event per timeframe per file.

Features

  • crossbeam enabled by default, for crossbeam channel support.
    This may create problems used in tokio environments. See #380.
    Use something like the following to disable it.
notify-debouncer-mini = { version = "*", default-features = false }

This also passes through to notify as crossbeam-channel feature.

  • serde for serde support of event types, off by default

lib.rs:

Debouncer for notify. Filters incoming events and emits only one event per timeframe per file.

Installation

[dependencies]
notify-debouncer-mini = "0.4.1"

In case you want to select specific features of notify, specify notify as dependency explicitly in your dependencies. Otherwise you can just use the re-export of notify from debouncer-mini.

notify-debouncer-mini = "0.4.1"
notify = { version = "..", features = [".."] }

Examples

See also the full configuration example here.

use notify_debouncer_mini::{notify::*,new_debouncer,DebounceEventResult};

  // Select recommended watcher for debouncer.
  // Using a callback here, could also be a channel.
  let mut debouncer = new_debouncer(Duration::from_secs(2), |res: DebounceEventResult| {
      match res {
          Ok(events) => events.iter().for_each(|e|println!("Event {:?} for {:?}",e.kind,e.path)),
          Err(e) => println!("Error {:?}",e),
      }
  }).unwrap();

  // Add a path to be watched. All files and directories at that path and
  // below will be monitored for changes.
  debouncer.watcher().watch(Path::new("."), RecursiveMode::Recursive).unwrap();

  // note that dropping the debouncer (as will happen here) also ends the debouncer
  // thus this demo would need an endless loop to keep running

Features

The following crate features can be turned on or off in your cargo dependency config:

  • crossbeam enabled by default, adds DebounceEventHandler support for crossbeam channels. Also enables crossbeam-channel in the re-exported notify. You may want to disable this when using the tokio async runtime.
  • serde enables serde support for events.

Caveats

As all file events are sourced from notify, the known problems section applies here too.

Dependencies

~0.4–9.5MB
~65K SLoC