Trait succinct::stream::BitRead

pub trait BitRead {
    fn read_bit(&mut self) -> Result<Option<bool>>;

    fn read_int<N: PrimInt>(&mut self, nbits: usize) -> Result<Option<N>> { ... }
    fn read_int_be<N: PrimInt>(&mut self, nbits: usize) -> Result<Option<N>> { ... }
}

Allows reading bits from a source.

Required methods

fn read_bit(&mut self) -> Result<Option<bool>>

Reads a single bit from the source.

End-of-file is indicated by Ok(None).

Loading content...

Provided methods

fn read_int<N: PrimInt>(&mut self, nbits: usize) -> Result<Option<N>>

Reads nbits bits as an integer, least-significant bit first.

fn read_int_be<N: PrimInt>(&mut self, nbits: usize) -> Result<Option<N>>

Reads nbits bits as an integer, most-significant bit first.

Loading content...

Implementations on Foreign Types

impl BitRead for VecDeque<bool>

fn read_bit(&mut self) -> Result<Option<bool>>

Loading content...

Implementors

impl<Inner: BitVec> BitRead for BitBuffer<Inner>

fn read_bit(&mut self) -> Result<Option<bool>>

Loading content...