[][src]Struct bbqueue::Consumer

pub struct Consumer { /* fields omitted */ }

An opaque structure, capable of reading data from the queue

Methods

impl Consumer
[src]

pub fn read(&mut self) -> Result<GrantR>
[src]

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 release(&mut self, used: usize, grant: GrantR)
[src]

Release a sequence of bytes from the buffer, allowing the space to be used by later writes

If used is larger than the given grant, this function will panic.

Trait Implementations

Auto Trait Implementations

impl !Sync for Consumer

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]