Struct BinaryReader

pub struct BinaryReader<T: Read> { /* private fields */ }

Analogous to the System.IO.BinaryReader C# Class.

Reads from any Read implementor.

Implementations

impl<T> BinaryReader<T>

where T: Read,

All functions in this implementation return an error if the underlying Read returns an error, or if there aren’t enough bytes to read. Individual functions list additional error conditions.

pub fn new(input: T) -> Self

Creates a new BinaryReader which will read data from the provided Reader.

pub fn read_byte(&mut self) -> Result<Result<u8, DataDecodeError>, Error>

Equivalent to the ReadByte method in C#. Reads one byte from the stream.

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

Equivalent to the ReadBytes method in C#. Reads the specified number of bytes.

pub fn peek_byte(&mut self) -> Result<Result<u8, DataDecodeError>, Error>

Doesn’t correspond to any specific c# method. Provided for convenience. Gets the next byte without advancing the data stream.

pub fn peek_bytes( &mut self, num_bytes: usize, ) -> Result<Result<&[u8], DataDecodeError>, Error>

Doesn’t correspond to any specific c# method. Provided for convenience. Gets the specified number of bytes without advancing the data stream.

pub fn read_7_bit_encoded_int( &mut self, ) -> Result<Result<i32, DataDecodeError>, Error>

Equivalent to the Read7BitEncodedInt method in C#. Returns DataDecodeError::IntegerOverflow if the encoded value does not fit within 32 bits.

pub fn read_7_bit_encoded_int64( &mut self, ) -> Result<Result<i64, DataDecodeError>, Error>

Equivalent to the Read7BitEncodedInt64 method in C#. Returns DataDecodeError::IntegerOverflow if the encoded value does not fit within 64 bits.

pub fn read_boolean(&mut self) -> Result<Result<bool, DataDecodeError>, Error>

Equivalent to the ReadBoolean method in C#.

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

Equivalent to the ReadSingle method in C#.

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

Equivalent to the ReadDouble method in C#.

pub fn read_f16(&mut self) -> Result<Result<f16, DataDecodeError>, Error>

Available on crate feature f16 only.

Equivalent to the ReadHalf method in C#. Requires the f16 feature.

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

Equivalent to the ReadString method in C#. Returns an DataDecodeError::InvalidUtf8 if the data read is not valid utf-8.

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

Equivalent to the ReadSByte method in C#.

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

Equivalent to the ReadInt16 method in C#.

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

Equivalent to the ReadInt32 method in C#.

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

Equivalent to the ReadInt64 method in C#.

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

Equivalent to the ReadUint16 method in C#.

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

Equivalent to the ReadUint32 method in C#.

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

Equivalent to the ReadUint64 method in C#.

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

Trait Implementations

impl<T: Clone + Read> Clone for BinaryReader<T>

fn clone(&self) -> BinaryReader<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Read> Debug for BinaryReader<T>

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

Formats the value using the given formatter.

impl<T: Hash + Read> Hash for BinaryReader<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq + Read> PartialEq for BinaryReader<T>

fn eq(&self, other: &BinaryReader<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq + Read> Eq for BinaryReader<T>

impl<T: Read> StructuralPartialEq for BinaryReader<T>