Add support for flume (#680)

* added support for flume

* documentation for flume feature

* update CHANGELOG.md

Author: RenDiego

CHANGELOG.md

@@ -1,7 +1,14 @@
 # Changelog
 
+## notify 9.0.0 (unreleased)
+- FEATURE: added support for the [`flume`](https://docs.rs/flume) crate
+
 ## debouncer-full 0.6.0 (unreleased)
 - FEATURE: allow `FileIdCache` trait implementations to choose ownership of the returned file-ids
+- FEATURE: added support for the [`flume`](https://docs.rs/flume) crate
+
+## debouncer-mini 0.7.0 (unreleased)
+- FEATURE: added support for the [`flume`](https://docs.rs/flume) crate
 
 ## file-id 0.2.3 (unreleased)
 - CHANGE: implement `AsRef<FileId>` for `FileId`

Cargo.toml

@@ -21,6 +21,7 @@ edition = "2021"
 [workspace.dependencies]
 bitflags = "2.7.0"
 crossbeam-channel = "0.5.0"
+flume = "0.11.1"
 deser-hjson = "2.2.4"
 env_logger = "0.11.2"
 file-id = { version = "0.2.2", path = "file-id" }

notify-debouncer-full/Cargo.toml

@@ -17,6 +17,7 @@ default = ["macos_fsevent"]
 serde = ["notify-types/serde"]
 web-time = ["notify-types/web-time"]
 crossbeam-channel = ["dep:crossbeam-channel", "notify/crossbeam-channel"]
+flume = ["dep:flume", "notify/flume"]
 macos_fsevent = ["notify/macos_fsevent"]
 macos_kqueue = ["notify/macos_kqueue"]
 serialization-compat-6 = ["notify/serialization-compat-6"]
@@ -25,6 +26,7 @@ serialization-compat-6 = ["notify/serialization-compat-6"]
 notify.workspace = true
 notify-types.workspace = true
 crossbeam-channel = { workspace = true, optional = true }
+flume = { workspace = true, optional = true }
 file-id.workspace = true
 walkdir.workspace = true
 log.workspace = true

notify-debouncer-full/README.md

@@ -16,6 +16,8 @@ A debouncer for [notify] that is optimized for ease of use.
 
 - `crossbeam-channel` passed down to notify, off by default
 
+- `flume` passed down to notify, off by default
+
 - `serialization-compat-6` passed down to notify, off by default
 
 [docs]: https://docs.rs/notify-debouncer-full

notify-debouncer-full/src/lib.rs

@@ -52,6 +52,7 @@
 //! - `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
+//! - `flume` 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
@@ -132,6 +133,13 @@ impl DebounceEventHandler for crossbeam_channel::Sender<DebounceEventResult> {
     }
 }
 
+#[cfg(feature = "flume")]
+impl DebounceEventHandler for flume::Sender<DebounceEventResult> {
+    fn handle_event(&mut self, event: DebounceEventResult) {
+        let _ = self.send(event);
+    }
+}
+
 impl DebounceEventHandler for std::sync::mpsc::Sender<DebounceEventResult> {
     fn handle_event(&mut self, event: DebounceEventResult) {
         let _ = self.send(event);

notify-debouncer-mini/Cargo.toml

@@ -16,6 +16,7 @@ repository.workspace = true
 default = ["macos_fsevent"]
 serde = ["notify-types/serde"]
 crossbeam-channel = ["dep:crossbeam-channel", "notify/crossbeam-channel"]
+flume = ["dep:flume", "notify/flume"]
 macos_fsevent = ["notify/macos_fsevent"]
 macos_kqueue = ["notify/macos_kqueue"]
 serialization-compat-6 = ["notify/serialization-compat-6"]
@@ -24,5 +25,6 @@ serialization-compat-6 = ["notify/serialization-compat-6"]
 notify.workspace = true
 notify-types.workspace = true
 crossbeam-channel = { workspace = true, optional = true }
+flume = { workspace = true, optional = true }
 log.workspace = true
 tempfile.workspace = true

notify-debouncer-mini/README.md

@@ -8,6 +8,8 @@ Tiny debouncer for [notify]. Filters incoming events and emits only one event pe
 
 - `crossbeam-channel` passed down to notify, off by default
 
+- `flume` passed down to notify, off by default
+
 - `serde` for serde support of event types, off by default
 
 - `serialization-compat-6` passed down to notify, off by default

notify-debouncer-mini/src/lib.rs

@@ -47,6 +47,7 @@
 //!
 //! - `serde` passed down to notify-types, off by default
 //! - `crossbeam-channel` passed down to notify, off by default
+//! - `flume` 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
@@ -161,6 +162,13 @@ impl DebounceEventHandler for crossbeam_channel::Sender<DebounceEventResult> {
     }
 }
 
+#[cfg(feature = "flume")]
+impl DebounceEventHandler for flume::Sender<DebounceEventResult> {
+    fn handle_event(&mut self, event: DebounceEventResult) {
+        let _ = self.send(event);
+    }
+}
+
 impl DebounceEventHandler for std::sync::mpsc::Sender<DebounceEventResult> {
     fn handle_event(&mut self, event: DebounceEventResult) {
         let _ = self.send(event);

notify/Cargo.toml

@@ -27,6 +27,7 @@ serialization-compat-6 = ["notify-types/serialization-compat-6"]
 [dependencies]
 notify-types.workspace = true
 crossbeam-channel = { workspace = true, optional = true }
+flume = { workspace = true, optional = true }
 filetime.workspace = true
 libc.workspace = true
 log.workspace = true

notify/src/lib.rs

@@ -262,6 +262,13 @@ impl EventHandler for crossbeam_channel::Sender<Result<Event>> {
     }
 }
 
+#[cfg(feature = "flume")]
+impl EventHandler for flume::Sender<Result<Event>> {
+    fn handle_event(&mut self, event: Result<Event>) {
+        let _ = self.send(event);
+    }
+}
+
 impl EventHandler for std::sync::mpsc::Sender<Result<Event>> {
     fn handle_event(&mut self, event: Result<Event>) {
         let _ = self.send(event);

notify/src/poll.rs

@@ -43,6 +43,13 @@ impl ScanEventHandler for crossbeam_channel::Sender<ScanEvent> {
     }
 }
 
+#[cfg(feature = "flume")]
+impl ScanEventHandler for flume::Sender<ScanEvent> {
+    fn handle_event(&mut self, event: ScanEvent) {
+        let _ = self.send(event);
+    }
+}
+
 impl ScanEventHandler for std::sync::mpsc::Sender<ScanEvent> {
     fn handle_event(&mut self, event: ScanEvent) {
         let _ = self.send(event);