Type Alias BitSlice

pub type BitSlice<O = u8> = BitSlice<O, Msb0>;

Aliased Type

struct BitSlice<O = u8> { /* private fields */ }

Trait Implementations

impl BitBuf for &BitSlice

fn advance(&mut self, count: usize)

Advance the internal cursor of the BitBuf by count bits.

fn remaining(&self) -> usize

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

fn chunk(&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 copy_to_slice(&mut self, dest: &mut BitSlice)

Copy bits from self into dest.

fn try_copy_to_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(self, limit: usize) -> Take<Self>

where Self: Sized,

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

where Self: Sized,

impl BitRead for &BitSlice

fn read_bits<O: BitStore>(&mut self, dest: &mut BitSlice<O>) -> Result<usize>

Pull some bits from this source into the specified buffer, returning how many bits were read.

fn read_bits_exact<O: BitStore>(&mut self, dest: &mut BitSlice<O>) -> Result<()>

Read the exact number of bits required to fill buf.

impl<S: BitStore> BitWrite for &mut BitSlice<S>

fn write_bits<O: BitStore>(&mut self, source: &BitSlice<O>) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_all_bits<O: BitStore>(&mut self, source: &BitSlice<O>) -> Result<()>

Write the entirety buf into self.