code review comment

holochain · Feb 2, 2024 · 9f8c3d9 · 9f8c3d9
1 parent 0741954
commit 9f8c3d9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/crates/tx5-core/src/evt.rs b/crates/tx5-core/src/evt.rs
@@ -10,7 +10,8 @@ impl std::fmt::Debug for EventPermit {
     }
 }
 
-/// Generic event sender.
+/// Sender side of an explicitly bounded channel that lets us send
+/// bounded (backpressured) events, but unbounded error messages.
 pub struct EventSend<E: From<Error>> {
     limit: Arc<tokio::sync::Semaphore>,
     send: tokio::sync::mpsc::UnboundedSender<(E, EventPermit)>,
@@ -67,7 +68,8 @@ impl<E: From<Error>> EventSend<E> {
     }
 }
 
-/// Generic event receiver.
+/// Receiver side of an explicitly bounded channel that lets us send
+/// bounded (backpressured) events, but unbounded error messages.
 pub struct EventRecv<E: From<Error>>(
     tokio::sync::mpsc::UnboundedReceiver<(E, EventPermit)>,
 );