Struct ReceiverRef

pub struct ReceiverRef<'a, T> { /* private fields */ }

A borrowing handle for receiving elements through a split bounded Channel.

Implementations

impl<T> ReceiverRef<'_, T>

pub fn close(&mut self)

Closes the channel, ensuring that all subsequent sends will fail.

pub fn len(&self) -> usize

Returns the number of queued elements.

pub fn max_capacity(&self) -> usize

Returns the maximum buffer capacity of the channel.

This is the capacity initially specified when creating the channel and remains constant.

pub fn capacity(&self) -> usize

Returns the current capacity of the channel.

The capacity goes down when sending a value and goes up when receiving a value. When the capacity is zero, any subsequent sends will only resolve once sufficient capacity is available

pub fn is_closed(&self) -> bool

Returns true if the channel is closed.

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

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

Receives an element through the channel.

Errors

Fails, if the channel is empty or disconnected.

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

Polls the channel, resolving if an element was received or the channel is closed, ignoring whether there are any remaining Sender(s) or not.

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

Receives an element through the channel.

Errors

Fails, if the channel is closed (i.e., all senders have been dropped).

Trait Implementations

impl<T> Debug for ReceiverRef<'_, T>

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

Formats the value using the given formatter.

impl<T> Drop for ReceiverRef<'_, T>

fn drop(&mut self)

Executes the destructor for this type.