Struct Queue

pub struct Queue<'a, T> { /* private fields */ }

Bounded FIFO queue of T.

Implementations

impl<T> Queue<'_, T>

pub fn new<'a>( allocator: &'a LinearAllocator<'_>, capacity: usize, ) -> Option<Queue<'a, T>>

Allocates room for capacity of T and creates a Queue using it.

pub fn from_mut(buffer: &mut [MaybeUninit<T>]) -> Option<Queue<'_, T>>

Creates a Queue using the given backing memory.

pub fn push_back(&mut self, value: T) -> Result<(), T>

Pushes value to the back of the queue, returning it back if there’s no room.

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

Removes and returns the value at the front of the queue, or None if the queue is empty.

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

Returns a borrow of the value at the front of the queue without removing it, or None if the queue is empty.

pub fn spare_capacity(&self) -> usize

The amount of elements that could be pushed before the array is full.

pub fn is_full(&self) -> bool

Returns true if there’s no more capacity for additional elements.

pub fn is_empty(&self) -> bool

Returns true if there’s no elements in the queue.

pub fn iter(&self) -> impl Iterator<Item = &T>

Returns an iterator of the elements currently in the queue.