Struct LockFreeQueueU32 

pub struct LockFreeQueueU32<T, const N: usize> { /* private fields */ }

Available on crate feature queue only.

Implementation of an Atomic queue

Implementations

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

pub unsafe fn try_pull_id(&self, id: u32) -> Option<T>

Try to pull an item from the queue after a consume.

Safety

• The id need to be take from the consume method, otherwise the queue may block.

pub unsafe fn try_consume(&self) -> Result<Option<u32>, QueueError<T>>

Try to consume an item from the queue

Safety

• Only one thread can consume from the queue otherwise the queue may block.

pub unsafe fn consume(&self) -> Result<u32, QueueError<T>>

Consume an item from the queue

Safety

• Only one thread can consume from the queue otherwise the queue may block.

pub fn push(&self, val: T) -> Result<(), QueueError<T>>

Push an item in the queue. Return an error if it can’t

pub unsafe fn try_pull(&self) -> Result<Option<T>, QueueError<T>>

Try to pull an item from the queue.

For a single consumer, it return a Full error if the queue was full to notify that item can be push again in the queue.

Safety

• Only one thread can pull from the queue otherwise the queue may block.

pub unsafe fn pull(&self) -> Result<T, QueueError<T>>

Pull an item from the queue.

For a single consumer, it return a Full error if the queue was full to notify that item can be push again in the queue.

Safety

• Only one thread can pull from the queue otherwise the queue may block.

Trait Implementations

impl<T, const N: usize> Debug for LockFreeQueueU32<T, N>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize> Drop for LockFreeQueueU32<T, N>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, const N: usize> QueueChecker<u32> for LockFreeQueueU32<T, N>

fn is_empty(&self) -> bool

Checks if the queue is empty. Prefer this method over len() != 0

fn is_full(&self) -> bool

Checks if the queue is full. Prefer this method over len() != max_capacity()

fn len(&self) -> u32

Returns the number of item in the queue.

fn max_capacity(&self) -> u32

Returns the maximum item capacity of the queue.