#events #notify #file-rename #notifications #file-watcher #watch

notify-debouncer-full

notify event debouncer optimized for ease of use

5 releases (breaking)

0.5.0 Jan 10, 2025
0.4.0 Oct 25, 2024
0.3.2 Oct 14, 2024
0.3.1 Aug 21, 2023
0.1.0 May 17, 2023

#101 in Filesystem

Download history 35649/week @ 2024-10-28 46116/week @ 2024-11-04 47045/week @ 2024-11-11 42158/week @ 2024-11-18 28571/week @ 2024-11-25 38943/week @ 2024-12-02 38291/week @ 2024-12-09 53066/week @ 2024-12-16 21800/week @ 2024-12-23 22012/week @ 2024-12-30 43541/week @ 2025-01-06 43432/week @ 2025-01-13 32312/week @ 2025-01-20 39252/week @ 2025-01-27 45879/week @ 2025-02-03 56992/week @ 2025-02-10

176,335 downloads per month
Used in 155 crates (53 directly)

MIT/Apache

240KB
4K SLoC

Notify Debouncer Full

» Docs

A debouncer for notify that is optimized for ease of use.

  • Only emits a single Rename event if the rename From and To events can be matched
  • Merges multiple Rename events
  • Takes Rename events into account and updates paths for events that occurred before the rename event, but which haven't been emitted, yet
  • Optionally keeps track of the file system IDs all files and stitches rename events together (FSevents, Windows)
  • Emits only one Remove event when deleting a directory (inotify)
  • Doesn't emit duplicate create events
  • Doesn't emit Modify events after a Create event

Features

  • crossbeam-channel passed down to notify, off by default

  • serialization-compat-6 passed down to notify, off by default


lib.rs:

A debouncer for [notify] that is optimized for ease of use.

  • Only emits a single Rename event if the rename From and To events can be matched
  • Merges multiple Rename events
  • Takes Rename events into account and updates paths for events that occurred before the rename event, but which haven't been emitted, yet
  • Optionally keeps track of the file system IDs all files and stitches rename events together (macOS FS Events, Windows)
  • Emits only one Remove event when deleting a directory (inotify)
  • Doesn't emit duplicate create events
  • Doesn't emit Modify events after a Create event

Installation

[dependencies]
notify-debouncer-full = "0.5.0"

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-full.

notify-debouncer-full = "0.5.0"
notify = { version = "..", features = [".."] }

Examples

use notify_debouncer_full::{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), None, |result: DebounceEventResult| {
    match result {
        Ok(events) => events.iter().for_each(|event| println!("{event:?}")),
        Err(errors) => errors.iter().for_each(|error| println!("{error:?}")),
    }
}).unwrap();

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

Features

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

  • serde passed down to notify-types, off by default
  • web-time passed down to notify-types, off by default
  • crossbeam-channel passed down to notify, off by default
  • macos_fsevent passed down to notify, off by default
  • macos_kqueue passed down to notify, off by default
  • serialization-compat-6 passed down to notify, off by default

Caveats

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

Dependencies

~0.2–7MB
~47K SLoC