Struct Receiver

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

Receives messages sent by Sender.

Implementations

impl<T> Receiver<T>

pub fn close_all(&self)

Disconnects all receivers from senders. The receivers will still receive all buffered or reserved messages before returning an error, allowing a graceful teardown.

pub async fn recv(&self) -> Result<T, RecvError>

Waits until there’s a message to be read and returns. Returns an error when there are no more messages in the queue and all Senders have been dropped.

pub fn try_recv(&self) -> Result<T, TryRecvError>

Checks if there’s a message to be read and returns immediately. Returns an error when the channel is disconnected or empty.

pub async fn recv_many( &self, vec: &mut Vec<T>, count: usize, ) -> Result<usize, RecvError>

pub fn try_recv_many( &self, vec: &mut Vec<T>, count: usize, ) -> Result<usize, TryRecvError>

Trait Implementations

impl<T> Clone for Receiver<T>

Cloning creates new a instance with the shared state and increases the internal reference counter. It is guaranteed that a single message will be distributed to exacly one receiver future awaited after calling recv().

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Drop for Receiver<T>

The last reciever that’s dropped will mark the channel as disconnected.

fn drop(&mut self)

Executes the destructor for this type.