Struct tokio::sync::watch::Receiver

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

This is supported on feature="sync" and feature="sync" only.

Receives values from the associated Sender.

Instances are created by the channel function.

Methods

impl<T> Receiver<T>

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

This is supported on feature="sync" and feature="sync" only.

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.borrow(), "hello");

impl<T: Clone> Receiver<T>

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

This is supported on feature="sync" and feature="sync" only.

Attempts to clone the latest value sent via the channel.

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.

impl<T: Clone> Stream for Receiver<T>

type Item = T

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<T>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.