sync: document when watch::send fails (#4021)

tokio-rs · Aug 3, 2021 · e662175 · e662175
1 parent 175d84e
commit e662175
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tokio/src/sync/watch.rs b/tokio/src/sync/watch.rs
@@ -422,6 +422,9 @@ impl<T> Drop for Receiver<T> {
 
 impl<T> Sender<T> {
     /// Sends a new value via the channel, notifying all receivers.
+    ///
+    /// This method fails if the channel has been closed, which happens when
+    /// every receiver has been dropped.
     pub fn send(&self, value: T) -> Result<(), error::SendError<T>> {
         // This is pretty much only useful as a hint anyway, so synchronization isn't critical.
         if 0 == self.shared.ref_count_rx.load(Relaxed) {