Struct binary_io::data::DataInputStream

pub struct DataInputStream<R: ?Sized> { /* fields omitted */ }

A type that can perform Binary IO Reads by passing through reads to a type that implements Read

Implementations

impl<R> DataInputStream<R>

pub const fn new(read: R, order: ByteOrder) -> Self

Constructs a new DataInputStream from a given stream, in the given byte order mode

pub const fn new_native(read: R) -> Self

Constructs a new DataInputStream from a given stream, in the native byte order mode

pub fn into_inner(self) -> R

Returns the inner stream

Trait Implementations

impl<R: Read + ?Sized> DataInput for DataInputStream<R>

fn byte_order(&self) -> ByteOrder

Gets the current byte order mode

fn set_byte_order(&mut self, order: ByteOrder)

Sets the current byte order mode

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

Reads exactly bytes.len() bytes into bytes. Returns an error if an End of File prevents reading the entire array.

fn read_byte(&mut self) -> Result<u8>

Reads a single byte, and returns it, or an error if a byte cannot be read

impl<R: Read + ?Sized> Read for DataInputStream<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<R: Read + Seek + ?Sized> Seek for DataInputStream<R>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

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

🔬 This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

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

Returns the current seek position from the start of the stream.