Add DebouncedEvent to debouncer-full

Author: dfaust

CHANGELOG.md

@@ -3,6 +3,10 @@
 v5 maintenance branch is on `v5_maintenance` after `5.2.0`  
 v4 commits split out to branch `v4_maintenance` starting with `4.0.16`
 
+## debouncer-full 0.2.0
+
+- CHANGE: emit events as `DebouncedEvent`s, each containing the original notify event and the time at which it occurred [#488]
+
 ## notify 6.0.0 (2023-05-17)
 
 - CHANGE: files and directories moved into a watch folder on Linux will now be reported as `rename to` events instead of `create` events [#480]

examples/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 [dev-dependencies]
 notify = { version = "6.0.0", path = "../notify" }
 notify-debouncer-mini = { version = "0.3.0", path = "../notify-debouncer-mini" }
-notify-debouncer-full = { version = "0.1.0", path = "../notify-debouncer-full" }
+notify-debouncer-full = { version = "0.2.0", path = "../notify-debouncer-full" }
 futures = "0.3"
 tempfile = "3.5.0"
 

notify-debouncer-full/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "notify-debouncer-full"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 rust-version = "1.60"
 description = "notify event debouncer optimized for ease of use"
@@ -26,7 +26,6 @@ crossbeam = ["crossbeam-channel","notify/crossbeam-channel"]
 [dependencies]
 notify = { version = "6.0.0", path = "../notify" }
 crossbeam-channel = { version = "0.5", optional = true }
-serde = { version = "1.0.89", features = ["derive"], optional = true }
 file-id = { version = "0.1.0", path = "../file-id" }
 walkdir = "2.2.2"
 parking_lot = "0.12.1"

notify-debouncer-full/README.md

@@ -6,6 +6,7 @@ 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 stiches rename events together (FSevents, Windows)
 * Emits only one `Remove` event when deleting a directory (inotify)
 * Doesn't emit duplicate create events
@@ -24,7 +25,5 @@ A debouncer for [notify] that is optimized for ease of use.
 
   This also passes through to notify as `crossbeam-channel` feature.
 
-- `serde` for serde support of event types, off by default
-
 [docs]: https://docs.rs/notify-debouncer-full
 [notify]: https://crates.io/crates/notify

notify-debouncer-full/src/debounced_event.rs

@@ -0,0 +1,57 @@
+use std::ops::{Deref, DerefMut};
+
+#[cfg(test)]
+use mock_instant::Instant;
+
+#[cfg(not(test))]
+use std::time::Instant;
+
+use notify::Event;
+
+/// A debounced event is emitted after a short delay.
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct DebouncedEvent {
+    /// The original event.
+    pub event: Event,
+
+    /// The time at which the event occurred.
+    pub time: Instant,
+}
+
+impl DebouncedEvent {
+    pub fn new(event: Event, time: Instant) -> Self {
+        Self { event, time }
+    }
+}
+
+impl Deref for DebouncedEvent {
+    type Target = Event;
+
+    fn deref(&self) -> &Self::Target {
+        &self.event
+    }
+}
+
+impl DerefMut for DebouncedEvent {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.event
+    }
+}
+
+impl Default for DebouncedEvent {
+    fn default() -> Self {
+        Self {
+            event: Default::default(),
+            time: Instant::now(),
+        }
+    }
+}
+
+impl From<Event> for DebouncedEvent {
+    fn from(event: Event) -> Self {
+        Self {
+            event,
+            time: Instant::now(),
+        }
+    }
+}