Struct buf_ref_reader::MmapBuffer

pub struct MmapBuffer { /* fields omitted */ }

Buffer that uses circular buffer implemented with mirrored memory maps

Trait Implementations

impl Buffer for MmapBuffer

type Error = AllocError

Error type emitted if failed to (re)allocate the buffer

fn new(size: usize) -> Result<Self, AllocError>

Allocate new buffer of at least size cap, or more.

fn filled(&self) -> &[u8]

Return filled part of the buffer

fn enlarge(&mut self) -> Result<(), AllocError>

Grow appendable() part of the buffer one way or the other (by e.g. reallocating filled part of the buffer, or reallocating buffer itself)

fn appendable(&mut self) -> &mut [u8]

Part of the buffer next to the filled() that can be used to append data.

fn grow(&mut self, amount: usize)

Attaches amount bytes of appendable() to filled() part of the buffer

fn consume(&mut self, amount: usize) -> &[u8]

Split filled() part of the buffer, returning up to amount bytes from the beginning while also marking them as discarded right after lifetime of returned slice ends (i.e. before another call to any of Buffer's methods that accepts &mut self).

fn len(&self) -> usize

Size of filled() part of the buffer