Struct Receiver 

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

The receiving side of a channel.

The receiver can only be called from a single thread.

Implementations

impl<T> Receiver<T>

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

Attempts to receive a message immediately.

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

Receives a message asynchronously, if necessary waiting until one becomes available.

pub async fn recv_timeout<D>( &mut self, deadline: D, ) -> Result<T, RecvTimeoutError>

where D: Future<Output = ()>,

Receives a message asynchronously, if necessary waiting until one becomes available or until the deadline elapses.

The deadline is specified as a Future that is expected to resolves to () after some duration, such as a tokio::time::Sleep future.

pub fn close(&self)

Closes the queue.

This prevents any further messages from being sent on the channel. Messages that were already sent can still be received, however, which is why a call to this method should typically be followed by a loop receiving all remaining messages.

For this reason, no counterpart to Sender::is_closed is exposed by the receiver as such method could easily be misused and lead to lost messages. Instead, messages should be received until a RecvError, RecvTimeoutError::Closed or TryRecvError::Closed error is returned.

Trait Implementations

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

type Item = T

Values yielded by the stream.

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

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.