Struct Consumer

pub struct Consumer<'a, const N: usize> { /* private fields */ }

Consumer is the primary interface for reading data from a BBBuffer.

Implementations

impl<'a, const N: usize> Consumer<'a, N>

pub fn read(&self) -> Result<GrantR<'a, N>>

Obtains a contiguous slice of committed bytes. This slice may not contain ALL available bytes, if the writer has wrapped around. The remaining bytes will be available after all readable bytes are released

use bbqueue::BBBuffer;

// Create and split a new buffer of 6 elements
let buffer: BBBuffer<6> = BBBuffer::new();
let (mut prod, mut cons) = buffer.try_split().unwrap();

// Successfully obtain and commit a grant of four bytes
let mut grant = prod.grant_max_remaining(4).unwrap();
assert_eq!(grant.buf().len(), 4);
grant.commit(4);

// Obtain a read grant
let mut grant = cons.read().unwrap();
assert_eq!(grant.buf().len(), 4);

pub fn split_read(&self) -> Result<SplitGrantR<'a, N>>

Obtains two disjoint slices, which are each contiguous of committed bytes. Combined these contain all previously commited data.

Trait Implementations

impl<'a, const N: usize> Send for Consumer<'a, N>

impl<'a, const N: usize> Sync for Consumer<'a, N>