Struct abi::bbqueue_ipc::bbbuffer::Consumer

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

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

Fields§

§bbq: NonNull<BBBuffer>§pd: PhantomData<&'a ()>

Implementations§

source§

impl<'a> Consumer<'a>

source

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

source

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§

source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for Consumer<'a>

§

impl<'a> RefUnwindSafe for Consumer<'a>

§

impl<'a> Unpin for Consumer<'a>

§

impl<'a> UnwindSafe for Consumer<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.