Struct lrl_test_compiler::bits::BitReader

[+] Show declaration

pub struct BitReader {
    data: Vec<u8>,
    cursor: usize,
    len: usize,
}

[−] Expand description

BitReader is a data structure for reading bit sized data from a sequence of bytes

Fields

data: Vec<u8>

[−] Expand description

The data in the BitReader

cursor: usize

[−] Expand description

The current position in the BitReader

len: usize

[−] Expand description

The length of content to read

Implementations

impl BitReader[−]

pub fn len(&self) -> usize

pub fn remaining_len(&self) -> usize[−]

Get the number of remaining bits to be read

pub fn skip(&mut self, n: usize) -> bool[−]

Skip n bits from the BitReader

pub fn read_u8(&mut self, len: usize) -> Option<u8>[−]

Read up to one byte from the BitReader

pub fn read_u16(&mut self, len: usize) -> Option<u16>[−]

Read up to two bytes from the BitReader

pub fn read_u32(&mut self, len: usize) -> Option<u32>[−]

Read up to four bytes from the BitReader

impl BitReader[−]

pub fn from_file(path: PathBuf) -> Result<Self, Error>[−]

Creates a BitReader from a file give the file's path

Trait Implementations

impl Clone for BitReader[+]

[+] Show hidden undocumented items

fn clone(&self) -> BitReader[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for BitReader[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl Eq for BitReader

impl<'a> From<&'a [u8]> for BitReader[+]

[+] Show hidden undocumented items

fn from(input: &'a [u8]) -> Self[−]

Performs the conversion.

impl From<BitWriter> for BitReader[+]

[+] Show hidden undocumented items

fn from(input: BitWriter) -> Self[−]

Performs the conversion.

impl From<Vec<u8>> for BitReader[+]

[+] Show hidden undocumented items

fn from(input: Vec<u8>) -> Self[−]

Performs the conversion.

impl PartialEq<BitReader> for BitReader[+]

[+] Show hidden undocumented items

fn eq(&self, other: &BitReader) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BitReader) -> bool[−]

This method tests for !=.

impl StructuralEq for BitReader

impl StructuralPartialEq for BitReader