Struct BinaryReader 

pub struct BinaryReader<'a> {
    pub stream: MemoryStream<'a>,
    pub endian: Endian,
}

Fields

stream: MemoryStream<'a>

endian: Endian

Implementations

impl<'a> BinaryReader<'a>

pub fn new_stream<'b>(stream: MemoryStream<'a>, endian: Endian) -> Self

Createa a new BinaryWriter with a predefined MemoryStream

pub fn new_vec(buffer: &'a mut Vec<u8>, endian: Endian) -> Self

Createa a new BinaryWriter with a predefined Vec<u8> buffer

use binary_modifier::{BinaryReader, Endian};

let mut test_vec = vec![0,1,2,3,4,6,7,8,9,0];
let reader = BinaryReader::new(&mut test_vec, Endian::Little);

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

Read a length-prefixed String from the stream.

pub fn swap_endianness(&mut self)

Swap endianness to allow for reversing the reading mid stream

pub fn read_char(&mut self) -> Result<char>

Read a character from the stream.

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

Read a bool from the stream.

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

Read a f32 from the stream.

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

Read a f64 from the stream.

pub fn read_isize(&mut self) -> Result<isize>

Read an isize from the stream.

pub fn read_usize(&mut self) -> Result<usize>

Read a usize from the stream.

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

Read a u64 from the stream.

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

Read an i64 from the stream.

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

Read a u32 from the stream.

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

Read an i32 from the stream.

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

Read a u16 from the stream.

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

Read an i16 from the stream.

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

Read a u8 from the stream.

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

Read an i8 from the stream.

pub fn read_bytes(&mut self, length: usize) -> Result<Vec<u8>>

Read bytes from the stream into a buffer.

pub fn read_bytes_at( &mut self, length: usize, position: usize, ) -> Result<Vec<u8>>

same as read_bytes but at a certain offset

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

Reads a string by reading the length before