heapless::mpmc

Struct MpMcQueue

Source
pub struct MpMcQueue<T, const N: usize> { /* private fields */ }
Expand description

MPMC queue with a capacity for N elements N must be a power of 2 The max value of N is u8::MAX - 1 if mpmc_large feature is not enabled.

Implementations§

Source§

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

Source

pub const fn new() -> Self

Creates an empty queue

Source

pub fn dequeue(&self) -> Option<T>

Returns the item in the front of the queue, or None if the queue is empty

Source

pub fn enqueue(&self, item: T) -> Result<(), T>

Adds an item to the end of the queue

Returns back the item if the queue is full

Trait Implementations§

Source§

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T, const N: usize> Sync for MpMcQueue<T, N>
where T: Send,

Auto Trait Implementations§

§

impl<T, const N: usize> !Freeze for MpMcQueue<T, N>

§

impl<T, const N: usize> !RefUnwindSafe for MpMcQueue<T, N>

§

impl<T, const N: usize> Send for MpMcQueue<T, N>
where T: Send,

§

impl<T, const N: usize> Unpin for MpMcQueue<T, N>
where T: Unpin,

§

impl<T, const N: usize> UnwindSafe for MpMcQueue<T, N>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.