Struct UnboundedReceiver

pub struct UnboundedReceiver<T>(/* private fields */);

An unbounded receiver, created with unbounded

Implementations

impl<T> UnboundedReceiver<T>

pub async fn recv(&self) -> Result<T, UnboundedRecvError>

Receive a value from the receiver half of this channel.

Will block until a value is received

Errors

Will produce an error if all senders are dropped

pub fn into_stream(self) -> UnboundedStream<T>

Turn this receiver into a stream.

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

Try to receive a value from the receiver.

Errors

Will return an error if no value is currently queued. This function will not block.

pub async fn drain_at_least_one(&self) -> Result<Vec<T>, UnboundedRecvError>

Asynchronously wait for at least 1 value to show up, then will greedily try to receive values until this receiver would block. The resulting values are returned.

It is guaranteed that the returning vec contains at least 1 value

Errors

Will return an error if there was an error retrieving the first value.

pub fn drain(&self) -> Result<Vec<T>, UnboundedRecvError>

Drains the receiver from all messages in the queue, but will not poll for more messages

Errors

Will return an error if all the senders get dropped before this ends.

pub fn len(&self) -> Option<usize>

Attempt to load the length of the messages in queue.

On some implementations this value does not exist, and this will return None.

Trait Implementations

impl<T> Debug for UnboundedReceiver<T>

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

Formats the value using the given formatter.