Struct UnboundedReceiver 

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

Receives values from the associated UnboundedSenders.

Created by unbounded_channel. Dropping it closes the channel and drops the values still queued.

Implementations

impl<T> UnboundedReceiver<T>

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

Receives the next value, waiting for one if the channel is open and empty. Answers None once the channel is closed and drained (no sender, and no reserved slot still to be used).

Cancel safe: a dropped future loses no value.

pub async fn recv_many(&mut self, buf: &mut Vec<T>, limit: usize) -> usize

Receives up to limit values into buf and answers how many, waiting for at least one. Answers 0 when limit is 0 or the channel ended.

Cancel safe: a dropped future loses no value.

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

Polls to receive the next value; the waker of cx is woken when a value arrives or the channel ends.

pub fn poll_recv_many( &mut self, cx: &mut Context<'_>, buf: &mut Vec<T>, limit: usize, ) -> Poll<usize>

Polls to receive up to limit values into buf; see recv_many.

pub fn try_recv(&mut self) -> Result<T, TryRecvError>

Receives the next value without waiting.

Errors

TryRecvError::Empty if a value may yet come, TryRecvError::Disconnected if the channel ended.

pub fn close(&mut self)

Closes the receiving half without dropping it: no further value can be sent, and sends that wait fail. The values already buffered, and the slots reserved before the close, stay usable.

pub fn is_closed(&self) -> bool

Whether the channel is closed: close was called, or every sender is gone. Buffered values may still be received.

pub fn is_empty(&self) -> bool

Whether the channel holds no value.

pub fn len(&self) -> usize

How many values the channel holds.

Trait Implementations

impl<T> Debug for UnboundedReceiver<T>

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

Formats the value using the given formatter.

impl<T> Drop for UnboundedReceiver<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.