Struct Receiver

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

The receiving side of a channel.

Implementations

impl<T> Receiver<T>

pub fn recv_timeout<D>(&self, timeout: D) -> Result<T, RecvError>

where D: Into<Timeout>,

Waits for a message to be received from the channel, but only for a limited time.

If the channel is empty and not disconnected, this call will block until the receive operation can proceed or the operation times out. wake up and return an error.

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

Blocks the current thread until a message is received or the channel is empty and disconnected.

If the channel is empty and not disconnected, this call will block until the receive operation can proceed.

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

Attempts to receive a message from the channel without blocking.

This method will either receive a message from the channel immediately, or return an error if the channel is empty.

This method is safe to use from IRQ context, if and only if the channel was created as a bounded channel.

impl<T> Receiver<T>

pub fn recv_timeout_async<'a>( &'a self, timeout: impl Into<Timeout>, ) -> impl Future<Output = Result<T, RecvError>> + 'a

Waits for a message to be received from the channel, but only for a limited time. Async version.

If the channel is empty and not disconnected, this call will block until the receive operation can proceed or the operation times out. wake up and return an error.

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

Blocks the current thread until a message is received or the channel is empty and disconnected. Async version.

If the channel is empty and not disconnected, this call will block until the receive operation can proceed.

Trait Implementations

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 for Receiver<T>

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

Formats the value using the given formatter.

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for Receiver<T>

impl<T: Send> Sync for Receiver<T>