Struct ReadBits 

pub struct ReadBits<R> { /* private fields */ }

Buffered bit-level reader that wraps an io::Read byte stream.

Implementations

impl<R> ReadBits<R>

pub fn new(reader: R) -> Self

Creates a new ReadBits wrapping the given reader.

impl<R> ReadBits<R>

where R: Read,

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

Read one bit from the stream.

Returns Ok(bit) if the bit was read successfully. Returns Err if the reader returned an error on read or if the reader is exhausted.

pub fn read_bits( &mut self, buffer: &mut [u8], bit_offset: usize, bit_len: usize, ) -> Result<usize>

Read bits into the buffer. bit_offset specifies the bit offset in the buffer to read into. All bits before bit_offset will be preserved. bit_len specifies number of bits to read.

Returns number of bits read. It would be the bit_len. Unless reader is exhausted.

Panics

The function will panic if buffer doesn’t fit bits in range bit_offset..bit_offset+bit_len. This means that buffer.len() must be equal or greater than (bit_offset + bit_len + 7) / 8.

Function can also panic if internal reader panics on read.

pub fn read_all_bits( &mut self, buffer: &mut [u8], bit_offset: usize, bit_len: usize, ) -> Result<()>

Reads exactly bit_len bits into buffer starting at bit_offset.

Unlike read_bits, this retries on partial reads and returns an error if the reader is exhausted before all bits are read.

Trait Implementations

impl<R> Read for ReadBits<R>

where R: Read,

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_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.