Trait BitReader 

pub trait BitReader<'de> {
    type Error: Error;

    // Required methods
    fn bits_left(&self) -> usize;
    fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>;

    // Provided methods
    fn read_bits_into(
        &mut self,
        dst: &mut BitSlice<u8, Msb0>,
    ) -> Result<usize, Self::Error> { ... }
    fn read_bits(
        &mut self,
        n: usize,
    ) -> Result<Cow<'de, BitSlice<u8, Msb0>>, Self::Error> { ... }
    fn skip(&mut self, n: usize) -> Result<usize, Self::Error> { ... }
}

Bitwise reader.

Required Associated Types

type Error: Error

Required Methods

fn bits_left(&self) -> usize

Returns count of bits left to read more

fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>

Reads only one bit.

Provided Methods

fn read_bits_into( &mut self, dst: &mut BitSlice<u8, Msb0>, ) -> Result<usize, Self::Error>

Reads dst.len() bits into given bitslice. Might be optimized by the implementation.

fn read_bits( &mut self, n: usize, ) -> Result<Cow<'de, BitSlice<u8, Msb0>>, Self::Error>

Reads n bits and returns possibly borrowed BitSlice

fn skip(&mut self, n: usize) -> Result<usize, Self::Error>

Reads and discards n bits

Implementations on Foreign Types

impl<'de> BitReader<'de> for &'de BitSlice<u8, Msb0>

type Error = StringError

fn bits_left(&self) -> usize

fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>

fn read_bits_into( &mut self, dst: &mut BitSlice<u8, Msb0>, ) -> Result<usize, Self::Error>

fn read_bits( &mut self, n: usize, ) -> Result<Cow<'de, BitSlice<u8, Msb0>>, Self::Error>

fn skip(&mut self, n: usize) -> Result<usize, Self::Error>

impl<'de> BitReader<'de> for &str

Binary string, e.g. "0010110...."

type Error = StringError

fn bits_left(&self) -> usize

fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>

impl<'de> BitReader<'de> for &[bool]

type Error = StringError

fn bits_left(&self) -> usize

fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>

fn skip(&mut self, n: usize) -> Result<usize, Self::Error>

impl<'de, R: BitReader<'de> + ?Sized> BitReader<'de> for &mut R

type Error = <R as BitReader<'de>>::Error

fn bits_left(&self) -> usize

fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>

fn read_bits_into( &mut self, dst: &mut BitSlice<u8, Msb0>, ) -> Result<usize, Self::Error>

fn read_bits( &mut self, n: usize, ) -> Result<Cow<'de, BitSlice<u8, Msb0>>, Self::Error>

fn skip(&mut self, n: usize) -> Result<usize, Self::Error>

impl<'de, R: BitReader<'de> + ?Sized> BitReader<'de> for Box<R>

type Error = <R as BitReader<'de>>::Error

fn bits_left(&self) -> usize

fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>

fn read_bits_into( &mut self, dst: &mut BitSlice<u8, Msb0>, ) -> Result<usize, Self::Error>

fn read_bits( &mut self, n: usize, ) -> Result<Cow<'de, BitSlice<u8, Msb0>>, Self::Error>

fn skip(&mut self, n: usize) -> Result<usize, Self::Error>

Implementors

impl<'de> BitReader<'de> for Owned

type Error = <&'de BitSlice<u8, Msb0> as BitReader<'de>>::Error

impl<'de, R1, R2> BitReader<'de> for Join<R1, R2>

where R1: BitReader<'de>, R2: BitReader<'de>,

type Error = <R1 as BitReader<'de>>::Error

impl<'de, R> BitReader<'de> for BitCounter<R>

where R: BitReader<'de>,

type Error = <R as BitReader<'de>>::Error

impl<'de, R> BitReader<'de> for Checkpoint<R>

where R: BitReader<'de>,

type Error = <Tee<R, BitVec<u8, Msb0>> as BitReader<'de>>::Error

impl<'de, R> BitReader<'de> for Io<R>

where R: Read,

type Error = Error

impl<'de, R, F, E> BitReader<'de> for MapErr<R, F>

where R: BitReader<'de>, F: FnMut(R::Error) -> E, E: Error,

type Error = E

impl<'de, R, W> BitReader<'de> for Tee<R, W>

where R: BitReader<'de>, W: BitWriter,

type Error = <R as BitReader<'de>>::Error