Struct UnboundedReceiver

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

The receiving end of an unbounded mpsc channel.

This value is created by the unbounded function.

Implementations

impl<T> UnboundedReceiver<T>

pub fn close(&mut 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 try_next(&mut self) -> Result<Option<T>, TryRecvError>

Tries to receive the next message without notifying a context if empty.

It is not recommended to call this function from inside of a future, only when you’ve otherwise arranged to be notified when the channel is no longer empty.

This function returns:

• Ok(Some(t)) when message is fetched
• Ok(None) when channel is closed and no messages left in the queue
• Err(e) when there are no messages available, but channel is not yet closed

Trait Implementations

impl<T> Debug for UnboundedReceiver<T>

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

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 UnboundedReceiver<T>