add comment to EventSubscriber

mongodb · Oct 19, 2020 · 931887a · 931887a
1 parent 7b5502d
commit 931887a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/cmap/test/event.rs b/src/cmap/test/event.rs
@@ -82,6 +82,9 @@ impl CmapEventHandler for EventHandler {
 }
 
 pub struct EventSubscriber<'a> {
+    /// A reference to the handler this subscriber is receiving events from.
+    /// Stored here to ensure this subscriber cannot outlive the handler that is generating its
+    /// events.
     _handler: &'a EventHandler,
     receiver: tokio::sync::broadcast::Receiver<Event>,
 }