Struct linebuffer::LineBuffer

pub struct LineBuffer<T, B> where
    T: Debug,
    B: ArrayLength<Entry<T>>,  { /* fields omitted */ }

Circular Line Buffer

Methods

impl<T, B> LineBuffer<T, B> where
    T: Debug,
    B: ArrayLength<Entry<T>>, 

pub fn new(max: usize) -> Self

Create new circular buffer of defined data size (bytes)

Note that this is not the amount of entries (lines). LineBuffer will wrap after reaching max bytes or the max amount of lines specified.

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> where
    T: Debug,  type Item = (&'a [u8], &'a T);

pub fn iter(&self) -> Iter<T>

Returns an iterator over the elements

Note that the first iteration step has some overhead to skip invalid entries.

pub fn elements(&self) -> usize

Total amount of inserted elements

pub fn capacity(&self) -> usize

Capacity of elements (lines)

pub fn capacity_bytes(&self) -> usize

Capacity of total bytes

Note that due to fragmentation it is not trivially possible to get the amount of free bytes

pub fn get(&self, idx: usize) -> Option<(&[u8], &T)>

Get element at index, idx counting up since first element inserted.

pub fn insert(&mut self, element: &[u8], addition: T)

Insert element at the front and an additional value, which can be used as flag