Add doc example

notify-rs · Aug 8, 2021 · 2ea2146 · 2ea2146
1 parent 2373fd8
commit 2ea2146
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -139,6 +139,23 @@ mod config;
 mod error;
 
 /// The set of requirements for watcher event handling functions.
+///
+/// # Example implementation
+///
+/// ```no_run
+/// use notify::{Event, Result, EventHandler};
+///
+/// /// Prints received events
+/// struct EventPrinter;
+///
+/// impl EventHandler for EventPrinter {
+///     fn handle_event(&mut self, event: Result<Event>) {
+///         if let Ok(event) = event {
+///             println!("Event: {:?}", event);
+///         }
+///     }
+/// }
+/// ```
 pub trait EventHandler: Send + 'static {
     /// Handles an event.
     fn handle_event(&mut self, event: Result<Event>);