Struct tokio_sync::watch::Receiver

pub struct Receiver<T> { /* fields omitted */ }

Receives values from the associated Sender.

Instances are created by the channel function.

Methods

impl<T> Receiver<T>

pub fn get_ref(&self) -> Ref<T>

Returns a reference to the most recently sent value

Outstanding borrows hold a read lock. This means that long lived borrows could cause the send half to block. It is recommended to keep the borrow as short lived as possible.

Examples

use tokio::sync::watch;

let (_, rx) = watch::channel("hello");
assert_eq!(*rx.get_ref(), "hello");

pub async fn recv_ref<'_, '_>(&'_ mut self) -> Option<Ref<'_, T>>

Attempts to receive the latest value sent via the channel.

If a new, unobserved, value has been sent, a reference to it is returned. If no new value has been sent, then Pending is returned and the current task is notified once a new value is sent.

Only the most recent value is returned. If the receiver is falling behind the sender, intermediate values are dropped.

impl<T: Clone> Receiver<T>

pub async fn recv<'_>(&'_ mut self) -> Option<T>

Attempts to clone the latest value sent via the channel.

This is equivalent to calling clone() on the value returned by recv().

Trait Implementations

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Clone for Receiver<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Receiver<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.