Struct Receiver

pub struct Receiver<I, P>
where
    P: Ord,
{ /* private fields */ }

Receive side of the channel. Can be cloned.

Implementations

impl<I, P> Receiver<I, P>

where P: Ord,

pub fn try_recv(&self) -> Result<(I, P), TryRecvError>

Attempts to receive a message from the channel.

If the channel is empty or closed, this method returns an error.

pub async fn recv(&self) -> Result<(I, P), RecvError>

Receives a message from the channel.

If the channel is empty, this method waits until there is a message.

If the channel is closed, this method receives a message or returns an error if there are no more messages.

pub fn close(&self) -> bool

Closes the channel and notifies all blocked operations.

Returns true if this call has closed the channel and it was not closed already.

pub fn is_closed(&self) -> bool

Returns whether the channel is closed

pub fn is_empty(&self) -> bool

Return true if the channel is empty

pub fn is_full(&self) -> bool

Return true if the channel is full

pub fn len(&self) -> u64

Returns the number of messages in the channel.

pub fn capacity(&self) -> Option<u64>

Returns the channel capacity if it’s bounded.

pub fn receiver_count(&self) -> usize

Returns the number of receivers for the channel.

pub fn sender_count(&self) -> usize

Returns the number of senders for the channel.

Trait Implementations

impl<I, P> Clone for Receiver<I, P>

where P: Ord,

fn clone(&self) -> Receiver<I, P>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Debug, P> Debug for Receiver<I, P>

where P: Ord + Debug,

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

Formats the value using the given formatter.

impl<I, P> Drop for Receiver<I, P>

where P: Ord,

fn drop(&mut self)

Executes the destructor for this type.