Struct Take

pub struct Take<T> { /* private fields */ }

A BitBuf adaptor which limits the bits read from an underlying buffer.

Implementations

impl<T> Take<T>

pub fn new(inner: T, limit: usize) -> Take<T>

impl<T> Take<T>

pub fn into_inner(self) -> T

pub fn get_ref(&self) -> &T

pub fn get_mut(&mut self) -> &mut T

pub fn limit(&self) -> usize

pub fn set_limit(&mut self, limit: usize)

Trait Implementations

impl<T: BitBuf> BitBuf for Take<T>

fn advance_bits(&mut self, count: usize)

Advance the internal cursor of the BitBuf by count bits.

fn remaining_bits(&self) -> usize

Returns the number of bits between the current position and the end of the buffer.

fn chunk_bits(&self) -> &BitSlice

Returns a BitSlice starting at the current position and of length between 0 and BitBuf::remaining. Note that this can return a shorter slice.

fn chunk_bytes(&self) -> &[u8]

Returns a slice of bytes starting at the current position and of length between 0 and BitBuf::remaining_bytes. Note that this can return a shorter slice.

fn byte_aligned(&self) -> bool

Returns whether or not this BitBuf is fully byte-aligned (beginning and end) with the underlying storage.

fn advance_bytes(&mut self, count: usize)

Advance the internal cursor of the BitBuf by count bytes.

fn remaining_bytes(&self) -> usize

Return the number of full bytes between the current position and the end of the buffer.

fn has_remaining_bits(&self) -> bool

Returns true if there are any more bits to consume.

fn has_remaining_bytes(&self) -> bool

Returns true if there are any more cmplete bytes to consume.

fn chain<U: BitBuf>(self, next: U) -> Chain<Self, U>

where Self: Sized,

Creates an adaptor which will chain this buffer to another.

fn copy_to_bit_slice(&mut self, dest: &mut BitSlice)

Copy bits from self into dest.

fn try_copy_to_bit_slice(&mut self, dest: &mut BitSlice) -> Result<()>

fn copy_to_slice_bytes(&mut self, dest: &mut [u8])

Copy bytes from self into dest. Call should call byte_aligned() beforehand to ensure buffer is fully byte-aligned before calling, call may panic if buffer isn’t byte-aligned.

fn try_copy_to_slice_bytes(&mut self, dest: &mut [u8]) -> Result<()>

Try to copy bytes from self into dest. Returns error if self is not big enough to fill dest or if self is not fully byte-aligned (start and end points both falling on byte boundaries).

fn take_bits(self, limit: usize) -> Take<Self>

where Self: Sized,

Create an adaptor which can read at most limit bits from self.

fn take_bytes(self, limit: usize) -> Take<Self>

where Self: Sized,

Create an adaptor which can read at most limit bytes from self.