Struct Channel

pub struct Channel<'a, M: RawMutex, T> { /* private fields */ }

A bounded zero-copy channel for communicating between asynchronous tasks with backpressure.

The channel will buffer up to the provided number of messages. Once the buffer is full, attempts to send new messages will wait until a message is received from the channel.

All data sent will become available in the same order as it was sent.

The channel requires a buffer of recyclable elements. Writing to the channel is done through an &mut T.

Implementations

impl<'a, M: RawMutex, T> Channel<'a, M, T>

pub fn new(buf: &'a mut [T]) -> Self

Initialize a new Channel.

The provided buffer will be used and reused by the channel’s logic, and thus dictates the channel’s capacity.

pub fn split(&mut self) -> (Sender<'_, M, T>, Receiver<'_, M, T>)

Creates a Sender and Receiver from an existing channel.

Further Senders and Receivers can be created through Sender::borrow and Receiver::borrow respectively.

pub fn clear(&mut self)

Clears all elements in the channel.

pub fn len(&self) -> usize

Returns the number of elements currently in the channel.

pub fn is_empty(&self) -> bool

Returns whether the channel is empty.

pub fn is_full(&self) -> bool

Returns whether the channel is full.