Struct bitio::BitReader

pub struct BitReader<R> { /* fields omitted */ }

Mainstructs are * BitReader for reading and * BitWriter for writing A wrapping Reader reading bitwise from its source. For now mainly a reimplementation of the C# version from -- http://rosettacode.org/wiki/Bitwise_IO

Methods

impl<R: Read> BitReader<R>

fn new(source: R) -> BitReader<R>

Creates a new BitReader

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

Reads a single Bit from the BitReader

fn read_bits(&mut self, bit_count: usize) -> Result<i32>

Gets a given count of Bits from the BitReader

fn read_byte(&mut self) -> Result<u8>

Read a single byte from the BitReader

fn read_bytes(&mut self, buf: &mut [u8], byte_count: usize) -> Result<usize>

Gets a given count of bytes from the BitReader. Mainly here for convenience. Could be implemented more efficient.

Trait Implementations

impl<R: Read> Read for BitReader<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

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

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API. (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.