mention Debouncer drop impl in documentation

This commit is contained in:
pantonshire committed 2023-08-18 09:31:20 +01:00
1 parent 7cf3f6eca2
commit b878d56833
1 file changed
+2
+2
View File
@@ -39,6 +39,8 @@ use std::{
/// # Ok(()) /// # Ok(())
/// # } /// # }
/// ``` /// ```
///
/// When dropped, the debouncer will close the mpsc channel associated with it.
pub struct Debouncer<RawEvent, DebouncedEvent, FoldFn> { pub struct Debouncer<RawEvent, DebouncedEvent, FoldFn> {
thread: Option<JoinHandle<()>>, thread: Option<JoinHandle<()>>,
// This is reference counted because the debouncer thread needs access to the controller, and // This is reference counted because the debouncer thread needs access to the controller, and