Struct RingBuf

pub struct RingBuf<T> { /* private fields */ }

ring buffer supporting batch copy in/out

safety: probably not

Implementations

impl<T> RingBuf<T>

pub fn new() -> RingBuf<T>

create new buffer

pub fn with_capacity(capacity: usize) -> RingBuf<T>

create new buffer with preallocated capacity

pub fn capacity(&self) -> usize

max capacity before reallocating

pub fn len(&self) -> usize

length of buffer

pub fn is_empty(&self) -> bool

whether buffer is empty

pub fn is_contiguous(&self) -> bool

determine if elements in backing buffer are in a contiguous segment

pub fn realign(&mut self)

realign all elements so they are contiguous at the beginning of the buffer

pub fn reserve(&mut self, count: usize)

reserve space for at least count more elements

pub fn reserve_exact(&mut self, count: usize)

reserve space for exactly count more elements (see Vec::reserve_exact)

pub fn shrink_to(&mut self, target_capacity: usize)

shrink backing buffer to given capacity

pub fn push_back(&mut self, val: T)

push one element to back of ring

pub fn push_front(&mut self, val: T)

push one element to front of ring

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

pop one element from back of ring

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

pop one element from front of ring

pub fn range(&self, range: Range<usize>) -> RingBufSlice<'_, T>

get immutable reference to range

pub fn range_mut(&mut self, range: Range<usize>) -> RingBufSliceMut<'_, T>

get mutable reference to range

pub fn get(&self, index: usize) -> Option<&T>

obtain reference to element at provided index

pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

obtain mutable reference to element at provided index

pub fn clear(&mut self)

clear all elements

pub fn drain<R: RangeBounds<usize>>(&mut self, range: R) -> Drain<'_, T>

remove range of elements from RingBuf and return iterator for those elements

Currently only supports draining from either the start or the end. Drained elements are dropped when the iterator is dropped.

impl<T: Clone> RingBuf<T>

pub fn fill_at_back(&mut self, count: usize, value: T)

append count elements at back by cloning

pub fn fill_at_front(&mut self, count: usize, value: T)

prepend count elements at front by cloning

impl<T: Copy> RingBuf<T>

pub fn push_back_copy_from_slice(&mut self, elements: &[T])

push contents of slice to back by copying

pub fn push_front_copy_from_slice(&mut self, elements: &[T])

push contents of slice to front by copying

pub fn pop_back_copy_to_slice(&mut self, dest: &mut [T])

pop contents to slice from back by copying

pub fn pop_front_copy_to_slice(&mut self, dest: &mut [T])

pop contents to slice from front by copying

Trait Implementations

impl<T> Drop for RingBuf<T>

fn drop(&mut self)

Executes the destructor for this type.