Struct canadensis_can::queue::ArrayQueue

pub struct ArrayQueue<I, const N: usize> { /* private fields */ }

A frame queue implemented as a ring buffer in a fixed-capacity array

N is the maximum number of frames that the queue can hold. This should be at least as large as the number of frames required for the largest outgoing transfer that will be sent.

Implementations

impl<I, const N: usize> ArrayQueue<I, N>where I: Default,

pub fn new() -> Self

Returns a new emtpy queue

pub fn len(&self) -> usize

Returns the number of frames in this queue

pub fn is_empty(&self) -> bool

Returns true if this queue does not contain any frames

pub fn capacity(&self) -> usize

Returns the maximum number of frames that this queue can hold

Trait Implementations

impl<I: Debug, const N: usize> Debug for ArrayQueue<I, N>

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

Formats the value using the given formatter.

impl<I, const N: usize> Default for ArrayQueue<I, N>where I: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<I, const N: usize> FrameQueue<I> for ArrayQueue<I, N>where I: Clone + Default,

fn try_reserve(&mut self, additional: usize) -> Result<(), OutOfMemoryError>

Attempts to reserve memory for some number of additional frames

fn shrink_to_fit(&mut self)

Attempts to free memory by reducing excess capacity in this queue

fn push_frame(&mut self, frame: Frame<I>) -> Result<(), OutOfMemoryError>

Pushes a frame onto the back of this queue

fn peek_frame(&self) -> Option<&Frame<I>>

Returns a reference to the frame at the front of the queue

fn pop_frame(&mut self) -> Option<Frame<I>>

Removes and returns the frame at the front of the queue

fn return_frame(&mut self, frame: Frame<I>) -> Result<(), OutOfMemoryError>

Returns a not-yet-transmitted frame to the queue