[−][src]Struct bbqueue_ng::Consumer
Consumer
is the primary interface for reading data from a BBBuffer
.
Implementations
impl<'a, const N: usize> Consumer<'a, { N }>
[src]
pub fn read(&mut self) -> Result<GrantR<'a, { N }>>
[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
use bbqueue_ng::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(&mut self) -> Result<SplitGrantR<'a, { N }>>
[src]
Obtains two disjoint slices, which are each contiguous of committed bytes. Combined these contain all previously commited data.
Trait Implementations
Auto Trait Implementations
impl<'a, const N: usize> !Sync for Consumer<'a, N>
[src]
impl<'a, const N: usize> Unpin for Consumer<'a, N>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,