Struct Receiver

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

A bounded receiver, created with [channel]

Implementations

impl<T> Receiver<T>

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

Receive a value from te channel. This will async block until a value is received, or until a RecvError is encountered.

Errors

Will return an error if the sender is dropped

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

where T: 'static,

Turn this recever into a stream. This may fail on some implementations if multiple references of a receiver exist

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

Try to receive a channel from the receiver. Will return immediately if there is no value available.

Errors

Will return an error if the sender is dropped

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

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 the sender is dropped

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

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

Errors

Will return an error if the sender is dropped

Trait Implementations

impl<T> Debug for Receiver<T>

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

Formats the value using the given formatter.