Struct binary_reader::BinaryReader

pub struct BinaryReader {
    pub data: Vec<u8>,
    pub pos: usize,
    pub length: usize,
    pub endian: Endian,
}

Binary reader.

Fields

data: Vec<u8>

The buffer data.

pos: usize

The current position.

length: usize

The length of the buffer.

endian: Endian

The endian of the buffer.

Implementations

impl BinaryReader

pub fn from_u8(get: &[u8]) -> BinaryReader

Initialize BinaryReader from u8 slice.

pub fn from_vec(vec: &Vec<u8>) -> BinaryReader

Initialize BinaryReader from u8 Vector.

pub fn from_file(file: &mut File) -> BinaryReader

Initialize BinaryReader from std::fs::File.

pub fn set_endian(&mut self, endian: Endian)

Set endian for read method.

pub fn jmp(&mut self, pos: usize)

Jump position.

pub fn adv(&mut self, size: usize)

pub fn align(&mut self, size: usize)

pub fn read(&mut self, size: usize) -> Option<&[u8]>

Read provided length size bytes.

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

Read provided length size bytes. Similar to BinaryReader::read but this returns std::io::Result instead of Option.

pub fn read_cstr(&mut self) -> Result<String>

Read cstr strings until null(aka 0x00) using std::string::String::from_utf8.

pub fn read_cstr_lossy(&mut self) -> Result<String>

Read cstr strings until null(aka 0x00) using std::string::String::from_utf8_lossy.

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

Read boolean. Note that anything other than 0x00 is considered true.

pub fn read_i8(&mut self) -> Result<i8>

Read signed 8 bit integer.

pub fn read_i16(&mut self) -> Result<i16>

Read signed 16 bit integer.

pub fn read_i24(&mut self) -> Result<i32>

Read signed 24 bit integer. Stored in i32.

pub fn read_i32(&mut self) -> Result<i32>

Read signed 32 bit integer.

pub fn read_i48(&mut self) -> Result<i64>

Read signed 48 bit integer. Stored in i64.

pub fn read_i64(&mut self) -> Result<i64>

Read signed 64 bit integer.

pub fn read_i128(&mut self) -> Result<i128>

Read signed 128 bit integer.

pub fn read_u8(&mut self) -> Result<u8>

Read unsigned 8 bit integer.

pub fn read_u16(&mut self) -> Result<u16>

Read unsigned 16 bit integer.

pub fn read_u24(&mut self) -> Result<u32>

Read unsigned 24 bit integer. Stored in u32.

pub fn read_u32(&mut self) -> Result<u32>

Read unsigned 32 bit integer.

pub fn read_u48(&mut self) -> Result<u64>

Read unsigned 48 bit integer. Stored in u64.

pub fn read_u64(&mut self) -> Result<u64>

Read unsigned 64 bit integer.

pub fn read_u128(&mut self) -> Result<u128>

Read unsigned 128 bit integer.

pub fn read_f32(&mut self) -> Result<f32>

Read 32 bit floating point number.

pub fn read_f64(&mut self) -> Result<f64>

Read 64 bit floating point number.

Trait Implementations

impl Clone for BinaryReader

fn clone(&self) -> BinaryReader

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BinaryReader

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

Formats the value using the given formatter.