Struct BinaryWriter 

pub struct BinaryWriter<W> { /* private fields */ }

Writer wrapper for binary scalar and length-prefixed string encoding.

Multi-byte methods use the configured ByteOrder.

Examples

use qubit_io::{
    BinaryWriter,
    ByteOrder,
};

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

assert_eq!(vec![0x34, 0x12], output.into_inner());

Implementations

impl<W> BinaryWriter<W>

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

Creates a binary writer.

Parameters

• inner: Writer to wrap.
• byte_order: Byte order used by multi-byte writes.

Returns

A new binary writer.

pub fn get_ref(&self) -> &W

Returns an immutable reference to the wrapped writer.

Returns

The wrapped writer reference.

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

Returns a mutable reference to the wrapped writer.

Returns

The wrapped writer reference.

pub fn into_inner(self) -> W

Consumes this wrapper and returns the wrapped writer.

Returns

The wrapped writer.

pub fn byte_order(&self) -> ByteOrder

Returns the byte order used by multi-byte writes.

Returns

The configured byte order.

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

Changes the byte order used by multi-byte writes.

Parameters

• byte_order: New byte order.

impl<W> BinaryWriter<W>

where W: Write,

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

Writes one unsigned byte.

Errors

Returns an I/O error from the wrapped writer.

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

Writes one signed byte.

Errors

Returns an I/O error from the wrapped writer.

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

Writes a u16 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

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

Writes an i16 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

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

Writes a u32 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

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

Writes an i32 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

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

Writes a u64 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

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

Writes an i64 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

pub fn write_u128(&mut self, value: u128) -> Result<()>

Writes a u128 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

pub fn write_i128(&mut self, value: i128) -> Result<()>

Writes an i128 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

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

Writes an f32 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

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

Writes an f64 using the configured byte order.

Errors

Returns an I/O error from the wrapped writer.

pub fn write_utf8_string_u16(&mut self, value: &str) -> Result<()>

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

Parameters

• value: String slice to write.

Errors

Returns an I/O error from the wrapped writer, or InvalidInput when the UTF-8 byte length does not fit into u16.

pub fn write_utf8_string_u32(&mut self, value: &str) -> Result<()>

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

Parameters

• value: String slice to write.

Errors

Returns an I/O error from the wrapped writer, or InvalidInput when the UTF-8 byte length does not fit into u32.

Trait Implementations

impl<W> Seek for BinaryWriter<W>

where W: 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.

impl<W> Write for BinaryWriter<W>

where W: Write,

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

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

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