Struct Mpmc 

pub struct Mpmc<T, const N: usize>(/* private fields */);

Multi-producer, multi-consumer, fixed-capacity async queue.

This wraps a MpMcQueue from the heapless crate, adding support for asynchronous enqueue and dequeue operations. N must be a power of two.

Implementations

impl<T, const N: usize> Mpmc<T, N>

pub const fn new() -> Self

Creates an empty queue.

pub fn inner(&self) -> &MpMcQueue<T, N>

Accesses the inner MpMcQueue.

pub async fn enqueue<S: EventMask>( &self, item: T, signals: &Signals<'_, S>, ev: S, )

Adds an item to the queue.

If the queue is full, this will wait on ev until a successful insertion. After inserting the item, ev will be raised in order to signal producers.

pub fn try_enqueue<S: EventMask>( &self, item: T, signals: &Signals<'_, S>, ev: S, ) -> Result<(), T>

Attempts to add an item to the queue.

If the queue is currently full, the item is returned in the Err variant. See also Mpmc::enqueue().

pub async fn dequeue<S: EventMask>(&self, signals: &Signals<'_, S>, ev: S) -> T

Removes an item from the queue.

If the queue is empty, this will wait on ev until an item is enqueued. After removing an item, ev will be raised to notify producers of available space in the queue.

pub fn try_dequeue<S: EventMask>( &self, signals: &Signals<'_, S>, ev: S, ) -> Result<T, Infallible>

Attempts to remove an item from the queue.

This will return WouldBlock if the queue is empty. See also Mpmc::dequeue().

Trait Implementations

impl<T, const N: usize> Default for Mpmc<T, N>

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize> From<MpMcQueue<T, N>> for Mpmc<T, N>

fn from(queue: MpMcQueue<T, N>) -> Self

Converts to this type from the input type.

impl<T, const N: usize> From<Mpmc<T, N>> for MpMcQueue<T, N>

fn from(queue: Mpmc<T, N>) -> Self

Converts to this type from the input type.