Struct GenericChunkedBuffer

pub struct GenericChunkedBuffer<const CHUNK_SIZE: usize> { /* private fields */ }

A deque style buffer that can be written to and read from.

The buffer is composed of a series of fixed size chunks.

This structure is useful for memory constrained environments. It limits the size of contiguous allocations and incrementally releases memory as the buffer is consumed.

Example code:

use chunked_buffer::ChunkedBuffer;

let mut buf = ChunkedBuffer::new();
buf.write(&[1, 2, 3]);
let mut dest = [0; 10];
let n = buf.read(&mut dest);
assert_eq!(n, 3);
assert_eq!(dest, [1, 2, 3, 0, 0, 0, 0, 0, 0, 0]);

Implementations

impl<const CHUNK_SIZE: usize> GenericChunkedBuffer<CHUNK_SIZE>

pub fn new() -> Self

Create a new, empty buffer

pub fn len(&self) -> usize

The number of bytes in the buffer

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty

pub fn read(&mut self, dest: &mut [u8]) -> usize

Consumes as many bytes as possible from the start of the buffer and writes them to dest

pub fn write(&mut self, src: &[u8])

pushes all the bytes in src to the end of the buffer

pub fn iter(&self) -> Iter<'_, CHUNK_SIZE>

Returns an iterator over u8 contained in buffer

pub fn iter_chunks(&self) -> IterChunk<'_, CHUNK_SIZE>

Returns an iterator over the chunks contained in buffer

pub fn to_vec(&self) -> Vec<u8>

Converts the buffer into a vector

Trait Implementations

impl<const CHUNK_SIZE: usize> Default for GenericChunkedBuffer<CHUNK_SIZE>

fn default() -> Self

Returns the “default value” for a type.

impl<const CHUNK_SIZE: usize> Index<usize> for GenericChunkedBuffer<CHUNK_SIZE>

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const CHUNK_SIZE: usize> IndexMut<usize> for GenericChunkedBuffer<CHUNK_SIZE>

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

Performs the mutable indexing (container[index]) operation.