Struct Capped 

pub struct Capped<'a, B: 'a + Buf + ?Sized> { /* private fields */ }

A soft-limited wrapper for impl Buf that doesn’t invoke extra work whenever the buffer is read from, only when the remaining bytes are checked. This means it can be nested arbitrarily without adding extra work every time.

Implementations

impl<'a, B: 'a + Buf + ?Sized> Capped<'a, B>

pub fn new(buf: &'a mut B) -> Self

Creates a Capped instance with a cap at the very end of the given buffer.

pub fn new_length_delimited(buf: &'a mut B) -> Result<Self, DecodeError>

Reads a length from the beginning of the given buffer, then returns a Capped instance with its cap at the end of the delimited range.

pub fn lend(&mut self) -> Capped<'_, B>

pub fn take_length_delimited(&mut self) -> Result<Capped<'_, B>, DecodeError>

Reads a length delimiter from the beginning of the wrapped buffer, then returns a subsidiary Capped instance for the delineated bytes if it does not overrun the underlying buffer or this instance’s cap.

pub fn buf(&mut self) -> &mut B

pub fn take_all(self) -> Take<&'a mut B>

pub fn decode_varint(&mut self) -> Result<u64, DecodeError>

pub fn remaining_before_cap(&self) -> usize

Returns the number of bytes left before the cap.

pub fn has_remaining(&self) -> Result<bool, DecodeErrorKind>

impl<'a> Capped<'_, &'a [u8]>

pub fn take_borrowed_length_delimited( &mut self, ) -> Result<&'a [u8], DecodeError>

Reads a length delimiter from the beginning of the wrapped slice, then advances that inner slice past the delineated bytes and returns them borrowed with lifetime if the instance’s cap is not overrun.

Trait Implementations

impl<B: Buf + ?Sized> Deref for Capped<'_, B>

type Target = B

The resulting type after dereferencing.

fn deref(&self) -> &B

Dereferences the value.

impl<B: Buf + ?Sized> DerefMut for Capped<'_, B>

fn deref_mut(&mut self) -> &mut B

Mutably dereferences the value.