Struct BytearrayRingbuffer 

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

Implementations

impl<const N: usize> BytearrayRingbuffer<N>

pub const fn new() -> Self

create empty BytearrayRingbuffer

pub const fn free(&self) -> usize

number of bytes available for payload, 8 bytes for header + end are already subtracted

pub fn push(&mut self, data: &[u8]) -> Result<(), NotEnoughSpaceError>

add element, returns NotEnoughSpaceError if there is not enough space available

pub fn push_force(&mut self, data: &[u8]) -> Result<(), NotEnoughSpaceError>

add element, discards oldest elements until data fits. Only when data is too large to fit the buffer (ie data.len() > N - 8), returns NotEnoughSpaceError

pub const fn empty(&self) -> bool

pub fn pop_front(&mut self) -> Option<(&[u8], &[u8])>

retrieve the oldest element, removing it from the buffer

pub fn iter_backwards<'a>(&'a self) -> IterBackwards<'a, N>

iterate over all items, starting with the newest one

pub fn iter<'a>(&'a self) -> Iter<'a, N>

iterate over all items, starting with the oldest one

pub const fn count(&self) -> usize

return the number of entries

pub fn nth(&self, n: usize) -> Option<(&[u8], &[u8])>

obtain the n-th entry

pub fn nth_reverse(&self, n: usize) -> Option<(&[u8], &[u8])>

obtain the n-th entry, starting from the newest entry

pub fn nth_contiguous(&mut self, n: usize) -> Option<&[u8]>

obtain the n-th entry, rolling the buffer around in case the element wraps around at the end of the buffer

Trait Implementations

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

fn default() -> Self

Returns the “default value” for a type.