Struct Channel 

pub struct Channel<T = ()> {
    pub sender: Sender<T>,
    pub receiver: Receiver<T>,
}

Channel struct that combines [async_channel::Sender] and [async_channel::Receiver] into a single struct with sender and receiver members representing a single channel.

Fields

sender: Sender<T>

Sender endpoint of the channel.

receiver: Receiver<T>

Receiver endpoint of the channel.

Implementations

impl<T> Channel<T>

pub fn unbounded() -> Channel<T>

Creates a channel with an unbounded message buffer.

pub fn bounded(cap: usize) -> Channel<T>

Creates a channel with a buffer bounded to cap messages.

pub fn oneshot() -> Channel<T>

Creates a oneshot channel (a bounded channel with a capacity of one message).

pub fn drain(&self) -> Result<(), TryRecvError>

Discards all currently-buffered messages from the channel.

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

Receives a message, waiting asynchronously until one is available.

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

Attempts to receive a message without blocking, returning an error if the channel is empty.

pub async fn send(&self, msg: T) -> Result<(), SendError<T>>

Sends a message, waiting asynchronously if the channel is bounded and full.

pub fn try_send(&self, msg: T) -> Result<(), TrySendError<T>>

Attempts to send a message without blocking, returning an error if the channel is full or closed.

pub fn len(&self) -> usize

Returns the number of messages currently buffered in the channel.

pub fn is_empty(&self) -> bool

Returns true if there are no messages currently buffered in the channel.

pub fn receiver_count(&self) -> usize

Returns the number of Receiver endpoints currently connected to the channel.

pub fn sender_count(&self) -> usize

Returns the number of Sender endpoints currently connected to the channel.

pub fn iter(&self) -> ChannelIterator<T>

Returns an iterator that drains all currently-buffered messages from the channel.

Trait Implementations

impl<T> Clone for Channel<T>

where T: Clone,

fn clone(&self) -> Channel<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Channel<T>

where T: Debug,

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

Formats the value using the given formatter.