Consumer

Struct Consumer 

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

A handle for reading from the buffer.

Implementations§

Source§

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

Source

pub fn bytes_available(&self) -> usize

Returns the number of bytes available to read.

Source

pub fn readable_bytes(&mut self) -> ReadableBytes<'_, N>

Returns a ReadableBytes handle granting access to the next contiguous slice of data.

This may not return all available bytes if the data wraps around the end of the buffer. In that case, you will need to consume the returned bytes and call this again to get the rest.

Source

pub fn discard_all(&mut self)

Discards all currently available data in the buffer.

Trait Implementations§

Source§

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

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

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>,

Source§

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>,

Source§

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.