Struct futures_channel::mpsc::UnboundedReceiver

[+] Show declaration

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

[−] Expand description

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 will panic if called after try_next or poll_next has returned None.

Trait Implementations

impl<T: Debug> Debug for UnboundedReceiver<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T> Drop for UnboundedReceiver<T>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

impl<T> FusedStream for UnboundedReceiver<T>[+]

[+] Show hidden undocumented items

fn is_terminated(&self) -> bool[−]

Returns true if the stream should no longer be polled.

impl<T> Stream for UnboundedReceiver<T>[+]

[+] Show hidden undocumented items

type Item = T

Values yielded by the stream.

fn poll_next(self: Pin<&mut 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.

fn size_hint(&self) -> (usize, Option<usize>)[−]

Returns the bounds on the remaining length of the stream.

impl<T> Unpin for UnboundedReceiver<T>