Struct abi::bbqueue_ipc::Consumer

pub struct Consumer<'a> {
    bbq: NonNull<BBBuffer>,
    pd: PhantomData<&'a ()>,
}

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

Fields

bbq: NonNull<BBBuffer>

pd: PhantomData<&'a ()>

Implementations

impl<'a> Consumer<'a>

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

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

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

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

Trait Implementations

impl<'a> Send for Consumer<'a>

impl<'a> Sync for Consumer<'a>