Struct bipbuffer::BipBuffer

pub struct BipBuffer<T> { /* fields omitted */ }

A Bip-Buffer object

Methods

impl<T: Default> BipBuffer<T>

pub fn new(length: usize) -> BipBuffer<T>

Creates and allocates a new buffer of T elements

pub fn clear(&mut self)

Clears all regions and reservations

Data in the underlying buffer is unchanged

pub fn reserve(&mut self, length: usize) -> Result<&mut [T], Error>

Returns a mutable buffer containing up to length slots for storing data.

If there is less free space than requested, the buffer size will equal the free space. Returns Error if there is no free space

pub fn commit(&mut self, length: usize)

Commits the data in the reservation, allowing it to be read later

If a length of 0 is passed in, the reservation will be cleared without making any other changes

pub fn read(&mut self) -> Option<&mut [T]>

Retrieves available (committed) data as a contiguous block.

Returns None if there is no data available

pub fn decommit(&mut self, length: usize)

Marks the first length elements of the available data is seen.

The next time read() is called, it will not include these elements.

pub fn committed_len(&self) -> usize

Number of committed elements

This approximates the size of the buffer that will be returned on read()

pub fn reserved_len(&self) -> usize

Number of reserved elements

This is the amount of available space for writing data to the buffer

pub fn len(&self) -> usize

Size of the backing store

Uses len() * size_of(T) + 6 * size_of(usize) memory overall

pub fn is_empty(&self) -> bool

Whether any space has been reserved or committed in the buffer

Trait Implementations

impl<T: Debug> Debug for BipBuffer<T>

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

Formats the value using the given formatter.