Struct UnboundedReceiver

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

The receiver of an unbounded mpsc channel.

This is created by the unbounded function.

Implementations

impl<T> UnboundedReceiver<T>

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

Try to read the next value from the channel.

This function will return:

• Ok(Some(T)) if a value is ready.
• Ok(None) if the channel has become closed.
• Err(TryRecvError) if the channel is not closed and the channel is empty.

pub fn close(&self)

Closes the receiver of the channel without dropping it.

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages in the buffer.

Trait Implementations

impl<T> Debug for UnboundedReceiver<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Drop for UnboundedReceiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> FusedStream for UnboundedReceiver<T>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T> Stream for UnboundedReceiver<T>

type Item = T

Values yielded by the stream.

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