Struct DataStream 

pub struct DataStream<T> { /* private fields */ }

A stream that allows endian-aware read and write.

This struct is generic over any type T that implements some combination of Read, Write, and Seek. Methods are conditionally available based on the traits implemented by T.

Implementations

impl<T> DataStream<T>

pub const fn new(inner: T, endian: Endian) -> Self

Creates a new DataStream with the given inner stream and endianness.

Trait Implementations

impl<T: Debug> Debug for DataStream<T>

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

Formats the value using the given formatter.

impl<T> Deref for DataStream<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for DataStream<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> EndianExt for DataStream<T>

fn endian(&self) -> Endian

Returns the current endianness.

fn set_endian(&mut self, endian: Endian)

Sets the endianness.

impl<T: Read> ReadExt for DataStream<T>

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

Reads exactly N bytes from the current stream.

fn read_length(&mut self, buffer: &mut [u8]) -> Result<usize, DataError>

Attempts to fill the buffer with data.

fn read_slice(&mut self, length: usize) -> Result<Cow<'_, [u8]>, DataError>

Reads a slice of the given length from the current position.

fn remaining_slice(&mut self) -> Result<Cow<'_, [u8]>, DataError>

Returns the remaining data from the current position.

fn read_string(&mut self, length: usize) -> Result<Cow<'_, str>, DataError>

Reads a UTF-8 encoded string of the given length from the current position.

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

Reads an unsigned 8-bit integer.

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

Reads a signed 8-bit integer.

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

Reads an unsigned 16-bit integer.

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

Reads a signed 16-bit integer.

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

Reads an unsigned 32-bit integer.

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

Reads a signed 32-bit integer.

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

Reads an unsigned 64-bit integer.

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

Reads a signed 64-bit integer.

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

Reads a 32-bit floating point number.

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

Reads a 64-bit floating point number.

impl<T: Seek> SeekExt for DataStream<T>

fn len(&mut self) -> Result<u64, DataError>

Returns the total length of the data.

Note that this can be an expensive operation due to seeking. You should instead use something like std::fs::Metadata::len.

Errors

Returns an error if unable to determine the length of the stream.

fn is_empty(&mut self) -> Result<bool, DataError>

Returns true if the remaining data is empty.

Note that this can be an expensive operation due to seeking.

Errors

Returns an error if unable to determine either the length of the stream or the position inside it.

fn position(&mut self) -> Result<u64, DataError>

Returns the current position.

fn set_position(&mut self, position: u64) -> Result<u64, DataError>

Sets the current position.

impl<T: Write> WriteExt for DataStream<T>

fn write_exact<const N: usize>( &mut self, bytes: &[u8; N], ) -> Result<(), DataError>

Writes exactly N bytes to the current stream.

fn write_u8(&mut self, value: u8) -> Result<(), DataError>

Writes an unsigned 8-bit integer.

fn write_i8(&mut self, value: i8) -> Result<(), DataError>

Writes a signed 8-bit integer.

fn write_u16(&mut self, value: u16) -> Result<(), DataError>

Writes an unsigned 16-bit integer.

fn write_i16(&mut self, value: i16) -> Result<(), DataError>

Writes a signed 16-bit integer.

fn write_u32(&mut self, value: u32) -> Result<(), DataError>

Writes an unsigned 32-bit integer.

fn write_i32(&mut self, value: i32) -> Result<(), DataError>

Writes a signed 32-bit integer.

fn write_u64(&mut self, value: u64) -> Result<(), DataError>

Writes an unsigned 64-bit integer.

fn write_i64(&mut self, value: i64) -> Result<(), DataError>

Writes a signed 64-bit integer.

fn write_f32(&mut self, value: f32) -> Result<(), DataError>

Writes a 32-bit floating point number.

fn write_f64(&mut self, value: f64) -> Result<(), DataError>

Writes a 64-bit floating point number.