Struct local_channel::mpsc::Receiver

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

The receiving end of a channel which implements the Stream trait.

This is created by the channel function.

Implementations

impl<T> Receiver<T>

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

Receive the next value.

Returns None if the channel is empty and has been closed explicitly or when all senders have been dropped and, therefore, no more values can ever be sent though this channel.

pub fn sender(&self) -> Sender<T>

Create an associated Sender.

Trait Implementations

impl<T: Debug> 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.

impl<T> Unpin for Receiver<T>