Struct BinaryReader 

pub struct BinaryReader<R> { /* private fields */ }

Reader wrapper for binary scalar and length-prefixed string decoding.

Multi-byte methods use the configured ByteOrder.

Examples

use std::io::Cursor;

use qubit_io::{
    BinaryReader,
    BinaryWriter,
    ByteOrder,
};

let mut output = BinaryWriter::new(Vec::new(), ByteOrder::BigEndian);
output.write_u16(0x1234)?;

let mut input = BinaryReader::new(Cursor::new(output.into_inner()), ByteOrder::BigEndian);
assert_eq!(0x1234, input.read_u16()?);

Implementations

impl<R> BinaryReader<R>

pub fn new(inner: R, byte_order: ByteOrder) -> Self

Creates a binary reader.

Parameters

• inner: Reader to wrap.
• byte_order: Byte order used by multi-byte reads.

Returns

A new binary reader.

pub fn get_ref(&self) -> &R

Returns an immutable reference to the wrapped reader.

Returns

The wrapped reader reference.

pub fn get_mut(&mut self) -> &mut R

Returns a mutable reference to the wrapped reader.

Returns

The wrapped reader reference.

pub fn into_inner(self) -> R

Consumes this wrapper and returns the wrapped reader.

Returns

The wrapped reader.

pub fn byte_order(&self) -> ByteOrder

Returns the byte order used by multi-byte reads.

Returns

The configured byte order.

pub fn set_byte_order(&mut self, byte_order: ByteOrder)

Changes the byte order used by multi-byte reads.

Parameters

• byte_order: New byte order.

impl<R> BinaryReader<R>

where R: Read,

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

Reads one unsigned byte.

Errors

Returns an I/O error from the wrapped reader.

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

Reads one signed byte.

Errors

Returns an I/O error from the wrapped reader.

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

Reads a u16 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads an i16 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads a u32 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads an i32 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads a u64 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads an i64 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads a u128 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads an i128 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads an f32 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

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

Reads an f64 using the configured byte order.

Errors

Returns an I/O error from the wrapped reader.

pub fn read_utf8_string_u16(&mut self, max_len: usize) -> Result<String>

Reads a UTF-8 string with a u16 byte-length prefix.

Parameters

• max_len: Maximum accepted UTF-8 payload length in bytes.

Errors

Returns an I/O error from the wrapped reader, or InvalidData when the payload length exceeds max_len or the payload is not valid UTF-8.

pub fn read_utf8_string_u32(&mut self, max_len: usize) -> Result<String>

Reads a UTF-8 string with a u32 byte-length prefix.

Parameters

• max_len: Maximum accepted UTF-8 payload length in bytes.

Errors

Returns an I/O error from the wrapped reader, or InvalidData when the payload length exceeds max_len or the payload is not valid UTF-8.

Trait Implementations

impl<R> BufRead for BinaryReader<R>

where R: BufRead,

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amount: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Checks if there is any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<R> Read for BinaryReader<R>

where R: Read,

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

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

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

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

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.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

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

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl<R> Seek for BinaryReader<R>

where R: Seek,

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

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

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

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).

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

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

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.