diff --git a/tokio/src/sync/watch.rs b/tokio/src/sync/watch.rs index 5a46670eeeb..569257540e5 100644 --- a/tokio/src/sync/watch.rs +++ b/tokio/src/sync/watch.rs @@ -854,6 +854,26 @@ impl Drop for Receiver { } impl Sender { + /// Creates the sending-half of the [`watch`] channel. + /// + /// See documentation of [`watch::channel`] for errors when calling this function. + /// Beware that attempting to send a value when no one subscribed to the channel will + /// return an error. + /// + /// [`watch`]: crate::sync::watch + /// [`watch::channel`]: crate::sync::watch + /// + /// # Examples + /// ``` + /// let sender = tokio::sync::watch::Sender::new(0u8); + /// assert!(sender.send(3).is_err()) + /// let _rec = sender.subscribe() + /// assert!(sender.send(4).is_ok()) + pub fn new(init: T) -> Self { + let (tx, _) = channel(init); + tx + } + /// Sends a new value via the channel, notifying all receivers. /// /// This method fails if the channel is closed, which is the case when