Struct 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 fn sender(&self) -> Sender<T>

Creates an additional sender for this channel.

pub fn close(&self)

Closes the receiving half of a channel, without dropping it.

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages that are buffered.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed.

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

Waits for the next message.

Returns None once the channel is closed or every sender has been dropped, and every buffered message has been received.

pub fn poll_recv(&self, cx: &mut Context<'_>) -> Poll<Option<T>>

Polls for the next message.

Returns Ready(None) once the channel is closed or every sender has been dropped, and every buffered message has been received.

Trait Implementations

impl<T> Debug for Receiver<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> FusedStream for Receiver<T>

fn is_terminated(&self) -> bool

Returns true once the channel is closed and every buffered message has been received.

impl<T> Stream for Receiver<T>

type Item = T

Values yielded by the stream.

fn poll_next( self: Pin<&mut Receiver<T>>, cx: &mut Context<'_>, ) -> Poll<Option<<Receiver<T> as Stream>::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>

impl<T> UnwindSafe for Receiver<T>