Struct iceoryx2_bb_container::queue::FixedSizeQueue

#[repr(C)]
pub struct FixedSizeQueue<T, const CAPACITY: usize> { /* private fields */ }

Relocatable queue with compile time fixed size capacity. In contrast to its counterpart the Queue it is movable.

Implementations

impl<T, const CAPACITY: usize> FixedSizeQueue<T, CAPACITY>

pub fn new() -> Self

Creates a new queue.

pub fn is_empty(&self) -> bool

Returns true if the queue is empty, otherwise false

pub fn clear(&mut self)

Removes all elements from the queue

pub fn capacity(&self) -> usize

Returns the capacity of the queue

pub fn len(&self) -> usize

Returns the number of elements inside the queue

pub fn is_full(&self) -> bool

Returns true if the queue is full, otherwise false

pub fn pop(&mut self) -> Option<T>

Acquire an element from the queue. If the queue is empty it returns None.

pub fn push(&mut self, value: T) -> bool

Adds an element to the queue. If the queue is full it returns false, otherwise true.

pub fn push_with_overflow(&mut self, value: T) -> Option<T>

Adds an element to the queue. If the queue is full it returns the oldest element, otherwise None.

impl<T: Copy + Debug, const CAPACITY: usize> FixedSizeQueue<T, CAPACITY>

pub unsafe fn get_unchecked(&self, index: usize) -> T

Returns a copy of the element stored at index. The index is starting by 0 for the first element until FixedSizeQueue::len().

Safety

• The index must be not out of bounds

pub fn get(&self, index: usize) -> T

Returns a copy of the element stored at index. The index is starting by 0 for the first element until FixedSizeQueue::len().

Trait Implementations

impl<T: Debug, const CAPACITY: usize> Debug for FixedSizeQueue<T, CAPACITY>

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

Formats the value using the given formatter.

impl<T, const CAPACITY: usize> Default for FixedSizeQueue<T, CAPACITY>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Send, const CAPACITY: usize> Send for FixedSizeQueue<T, CAPACITY>

impl<T: Sync, const CAPACITY: usize> Sync for FixedSizeQueue<T, CAPACITY>