Struct futures_channel::mpsc::UnboundedReceiver

[+] Show declaration

pub struct UnboundedReceiver<T>(_);

[−] Expand description

The receiving end of an unbounded mpsc channel.

This value is created by the unbounded function.

Methods

impl<T> UnboundedReceiver<T>

[−]

pub fn close(&mut self)

[−]

Closes the receiving half 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 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.

Trait Implementations

impl<T: Debug> Debug for UnboundedReceiver<T>

[+]

fn fmt(&self, f: &mut Formatter) -> Result

[−]

Formats the value using the given formatter.

impl<T> Unpin for UnboundedReceiver<T>

impl<T> Stream for UnboundedReceiver<T>

[+]

type Item = T

Values yielded by the stream.

fn poll_next(self: PinMut<Self>, 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.