sync: add is_closed method to watch sender (#2991)

1 files changed, 20 insertions, 3 deletions

diff --git a/tokio/src/sync/watch.rs b/tokio/src/sync/watch.rs
index 7d1ac9e8..ec73832f 100644
--- a/tokio/src/sync/watch.rs
+++ b/tokio/src/sync/watch.rs
@@ -33,9 +33,9 @@
 //!
 //! # Closing
 //!
-//! [`Sender::closed`] allows the producer to detect when all [`Receiver`]
-//! handles have been dropped. This indicates that there is no further interest
-//! in the values being produced and work can be stopped.
+//! [`Sender::is_closed`] and [`Sender::closed`] allow the producer to detect
+//! when all [`Receiver`] handles have been dropped. This indicates that there
+//! is no further interest in the values being produced and work can be stopped.
 //!
 //! # Thread safety
 //!
@@ -48,6 +48,7 @@
 //! [`Receiver::changed()`]: crate::sync::watch::Receiver::changed
 //! [`Receiver::borrow()`]: crate::sync::watch::Receiver::borrow
 //! [`channel`]: crate::sync::watch::channel
+//! [`Sender::is_closed`]: crate::sync::watch::Sender::is_closed
 //! [`Sender::closed`]: crate::sync::watch::Sender::closed
 
 use crate::sync::Notify;
@@ -336,6 +337,22 @@ impl<T> Sender<T> {
         Ok(())
     }
 
+    /// Checks if the channel has been closed. This happens when all receivers
+    /// have dropped.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// let (tx, rx) = tokio::sync::watch::channel(());
+    /// assert!(!tx.is_closed());
+    ///
+    /// drop(rx);
+    /// assert!(tx.is_closed());
+    /// ```
+    pub fn is_closed(&self) -> bool {
+        self.shared.ref_count_rx.load(Relaxed) == 0
+    }
+
     /// Completes when all receivers have dropped.
     ///
     /// This allows the producer to get notified when interest in the produced