4 releases (breaking)
0.4.0 | Oct 25, 2024 |
---|---|
0.3.2 | Oct 14, 2024 |
0.3.1 |
|
0.2.0 | Jun 15, 2023 |
0.1.0 | May 17, 2023 |
#108 in Filesystem
158,604 downloads per month
Used in 135 crates
(44 directly)
235KB
4K
SLoC
Notify Debouncer Full
A debouncer for notify that is optimized for ease of use.
- Only emits a single
Rename
event if the renameFrom
andTo
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 aCreate
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 renameFrom
andTo
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 aCreate
event
Installation
[dependencies]
notify-debouncer-full = "0.3.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-full.
notify-debouncer-full = "0.3.1"
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:
crossbeam-channel
passed down to notify, off by defaultserialization-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
~48K SLoC