Struct RingArrayBuf 

pub struct RingArrayBuf<const N: usize> { /* private fields */ }

Available on crate feature extend only.

A generic ring buffer implementation using arrays of the size of the power of two as internal buffers.

N must be a power of 2.

Trait Implementations

impl<const N: usize> Clone for RingArrayBuf<N>

fn clone(&self) -> RingArrayBuf<N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const N: usize> Debug for RingArrayBuf<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for RingArrayBuf<N>

fn default() -> Self

The ring buffer is filled with zeros to match Zeroable::zeroed().

impl<const N: usize> Index<usize> for RingArrayBuf<N>

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const N: usize> RingBuffer for RingArrayBuf<N>

const BUFFER_SIZE: usize = N

The size of the internal buffer in bytes.

fn initialize(&mut self, byte: u8)

Initialize the ring buffer by filling it up with the given byte value.

fn initialize_with(&mut self, init: impl FnOnce(&mut [u8]))

Initialize the ring buffer using a custom function that should fill it with predetermined values.

fn cursor(&self) -> usize

Return the current value of the internal cursor.

fn set_cursor(&mut self, pos: isize)

Set the current value of the internal cursor.

fn push(&mut self, byte: u8)

Push the new byte value to the buffer, overwriting the oldest one and advance the ring buffer cursor.

fn iter_from_offset(&mut self, offset: usize) -> HistoryIter<'_, Self>

Return an iterator which will yield consecutive bytes from the buffer starting at -offset from the last element.

fn iter_from_index(&mut self, pos: usize) -> HistoryIter<'_, Self>

Return an iterator which will yield consecutive bytes from the buffer starting from the absolute buffer index.

impl<const N: usize> Zeroable for RingArrayBuf<N>

fn zeroed() -> Self

Calls zeroed.