Skip to main content

ZigZagWriter

Struct ZigZagWriter 

Source
pub struct ZigZagWriter<W> { /* private fields */ }
Expand description

Writer wrapper for canonical ZigZag + unsigned LEB128 integers.

§Target-width integers

isize methods use the current Rust target’s pointer width. Prefer fixed-width integer methods such as write_i64 for persistent files and cross-platform protocols.

§Type Parameters

  • W: Underlying byte output.

§Partial writes

These methods are not transactional. An output error may occur after the output has accepted a byte prefix of the encoded value, and those bytes are not rolled back. Calling a method again encodes the entire value from the output’s current position and may duplicate that prefix. Recovery requires outer framing, a trusted seek or rollback strategy, or a transactional transport. Output acceptance does not imply durable persistence.

§Examples

use qubit_io_binary::ZigZagWriter;

let mut writer = ZigZagWriter::new(Vec::new());
writer.write_i8(-1).expect("value should be written");
assert_eq!(writer.into_inner(), vec![1]);

Implementations§

Source§

impl<W> ZigZagWriter<W>

Source

pub const fn new(inner: W) -> Self

Creates a ZigZag writer.

§Parameters
  • inner: Underlying byte output.
§Returns

Returns a canonical ZigZag writer.

Source

pub const fn inner(&self) -> &W

Returns a shared reference to the underlying writer.

§Returns

Returns the wrapped writer.

Source

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

Returns an exclusive reference to the underlying writer.

§Returns

Returns mutable access to the wrapped writer.

Source

pub fn into_inner(self) -> W

Consumes this wrapper and returns the underlying writer.

§Returns

Returns the wrapped writer.

Source§

impl<W> ZigZagWriter<W>
where W: ByteOutput,

Source

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

Writes a ZigZag i8.

§Parameters
  • value: Signed integer to encode and write.
§Returns

Returns after the canonical payload has been written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

Source

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

Writes a ZigZag i16.

§Parameters
  • value: Signed integer to encode and write.
§Returns

Returns after the canonical payload has been written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

Source

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

Writes a ZigZag i32.

§Parameters
  • value: Signed integer to encode and write.
§Returns

Returns after the canonical payload has been written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

Source

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

Writes a ZigZag i64.

§Parameters
  • value: Signed integer to encode and write.
§Returns

Returns after the canonical payload has been written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

Source

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

Writes a ZigZag i128.

§Parameters
  • value: Signed integer to encode and write.
§Returns

Returns after the canonical payload has been written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

Source

pub fn write_isize(&mut self, value: isize) -> Result<()>

Writes a ZigZag isize.

§Parameters
  • value: Signed integer to encode and write.
§Returns

Returns after the canonical payload has been written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

Source§

impl<W> ZigZagWriter<W>
where W: ByteOutput,

Source

pub fn is_buffered(&self) -> bool

Returns whether this writer buffers output.

§Returns

Returns true when writes may be retained in an internal buffer.

Source

pub unsafe fn write_unchecked( &mut self, input: &[u8], index: usize, count: usize, ) -> Result<usize>

Writes up to count bytes from an indexed input range.

§Parameters
  • input: Source byte buffer.
  • index: Start of the readable range.
  • count: Maximum number of bytes to write.
§Returns

Returns the number of bytes written.

§Errors

Returns the underlying output error.

§Safety

index..index + count must be a valid range within input.

Source

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

Writes bytes from the full input slice.

§Parameters
  • input: Source byte buffer.
§Returns

Returns the number of bytes written.

§Errors

Returns the underlying output error.

Source

pub unsafe fn write_fully_unchecked( &mut self, input: &[u8], index: usize, count: usize, ) -> Result<()>

Writes all bytes from an indexed input range.

§Parameters
  • input: Source byte buffer.
  • index: Start of the readable range.
  • count: Number of bytes to write.
§Errors

Returns the underlying output error if the complete range cannot be written.

§Safety

index..index + count must be a valid range within input.

Source

pub fn write_fully(&mut self, input: &[u8]) -> Result<()>

Writes all bytes from the full input slice.

§Parameters
  • input: Source byte buffer.
§Errors

Returns the underlying output error if the complete slice cannot be written.

Source

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

Flushes buffered output.

§Errors

Returns the underlying output error if buffered bytes cannot be flushed.

Source§

impl<W> ZigZagWriter<W>

Source

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

Seeks the wrapped byte stream; see Seekable::seek_to for the seek contract. Buffered wrappers interpret relative offsets and report positions relative to their logical stream position. A position query does not flush buffered output.

§Parameters
  • position: Relative or absolute target position.
§Returns

Returns the resulting stream position in bytes. For buffered wrappers this is the logical position, including buffered data.

§Errors

Returns the underlying seek error.

Trait Implementations§

Source§

impl<W> Output for ZigZagWriter<W>
where W: ByteOutput,

Source§

type Item = u8

The byte item type emitted by this ZigZag writer.

Source§

fn is_buffered(&self) -> bool

Reports whether the wrapped output is buffered.

§Returns

Returns the wrapped output’s buffering state.

Source§

unsafe fn write_unchecked( &mut self, input: &[u8], index: usize, count: usize, ) -> Result<usize>

Writes up to count bytes from an indexed input range.

§Parameters
  • input: Source slice.
  • index: First source index.
  • count: Maximum number of bytes to write.
§Returns

Returns the number of bytes written.

§Errors

Returns an error reported by the wrapped output.

§Safety

index..index + count must be a valid range within input.

Source§

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

Flushes the wrapped writer.

§Returns

Returns after the wrapped output has flushed.

§Errors

Returns the I/O error reported by the wrapped writer.

Source§

fn into_std_write(self) -> StdWrite<Self> ⓘ
where Self: Sized + ByteOutput,

Converts this byte output into a standard library writer. Read more
Source§

fn write(&mut self, input: &[Self::Item]) -> Result<usize, Error>

Writes items from the full input slice. Read more
Source§

unsafe fn write_fully_unchecked( &mut self, input: &[Self::Item], index: usize, count: usize, ) -> Result<(), Error>

Writes all items from an indexed input range. Read more
Source§

fn write_fully(&mut self, input: &[Self::Item]) -> Result<(), Error>

Writes all items from the full input slice. Read more
Source§

fn write_vectored(&mut self, buffers: &[&[Self::Item]]) -> Result<usize, Error>

Writes items from multiple buffers in list order. Read more
Source§

impl<W> Seekable for ZigZagWriter<W>

Source§

type Unit = u8

The byte unit used to measure positions in the wrapped writer.

Source§

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

Seeks the wrapped writer.

§Parameters
  • position: Target seek position.
§Returns

Returns the new stream position.

§Errors

Returns the seek error reported by the wrapped writer.

Auto Trait Implementations§

§

impl<W> Forget for ZigZagWriter<W>

§

impl<W> Freeze for ZigZagWriter<W>
where W: Freeze,

§

impl<W> Move for ZigZagWriter<W>

§

impl<W> RefUnwindSafe for ZigZagWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for ZigZagWriter<W>
where W: Send,

§

impl<W> Sync for ZigZagWriter<W>
where W: Sync,

§

impl<W> Unpin for ZigZagWriter<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for ZigZagWriter<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for ZigZagWriter<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<W> BinaryWriteExt for W
where W: ByteOutput + ?Sized,

Source§

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

Writes an unsigned 8-bit integer. Read more
Source§

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

Writes a signed 8-bit integer. Read more
Source§

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

Writes an unsigned 16-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian unsigned 16-bit integer. Read more
Source§

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

Writes a little-endian unsigned 16-bit integer. Read more
Source§

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

Writes an unsigned 32-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian unsigned 32-bit integer. Read more
Source§

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

Writes a little-endian unsigned 32-bit integer. Read more
Source§

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

Writes an unsigned 64-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian unsigned 64-bit integer. Read more
Source§

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

Writes a little-endian unsigned 64-bit integer. Read more
Source§

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

Writes an unsigned 128-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian unsigned 128-bit integer. Read more
Source§

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

Writes a little-endian unsigned 128-bit integer. Read more
Source§

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

Writes a signed 16-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian signed 16-bit integer. Read more
Source§

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

Writes a little-endian signed 16-bit integer. Read more
Source§

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

Writes a signed 32-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian signed 32-bit integer. Read more
Source§

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

Writes a little-endian signed 32-bit integer. Read more
Source§

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

Writes a signed 64-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian signed 64-bit integer. Read more
Source§

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

Writes a little-endian signed 64-bit integer. Read more
Source§

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

Writes a signed 128-bit integer using a runtime byte order. Read more
Source§

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

Writes a big-endian signed 128-bit integer. Read more
Source§

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

Writes a little-endian signed 128-bit integer. Read more
Source§

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

Writes a 32-bit float using a runtime byte order. Read more
Source§

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

Writes a big-endian 32-bit float. Read more
Source§

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

Writes a little-endian 32-bit float. Read more
Source§

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

Writes a 64-bit float using a runtime byte order. Read more
Source§

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

Writes a big-endian 64-bit float. Read more
Source§

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

Writes a little-endian 64-bit float. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByteOutput for T
where T: Output<Item = u8> + ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<W> Leb128WriteExt for W
where W: ByteOutput + ?Sized,

Source§

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

Writes an unsigned LEB128 u8. Read more
Source§

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

Writes an unsigned LEB128 u16. Read more
Source§

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

Writes an unsigned LEB128 u32. Read more
Source§

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

Writes an unsigned LEB128 u64. Read more
Source§

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

Writes an unsigned LEB128 u128. Read more
Source§

fn write_uleb_usize(&mut self, value: usize) -> Result<()>

Writes an unsigned LEB128 usize. Read more
Source§

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

Writes a signed LEB128 i8. Read more
Source§

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

Writes a signed LEB128 i16. Read more
Source§

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

Writes a signed LEB128 i32. Read more
Source§

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

Writes a signed LEB128 i64. Read more
Source§

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

Writes a signed LEB128 i128. Read more
Source§

fn write_sleb_isize(&mut self, value: isize) -> Result<()>

Writes a signed LEB128 isize. Read more
Source§

impl<T> SeekableByteOutput for T
where T: SeekableOutput<Item = u8, Unit = u8> + ?Sized,

Source§

impl<T> SeekableOutput for T
where T: Output + Seekable<Unit = <T as Output>::Item> + ?Sized,

Source§

impl<T> StringWriteExt for T
where T: ByteOutput + ?Sized,

Source§

fn write_utf8_payload(&mut self, value: &str) -> Result<(), Error>

Writes the string’s UTF-8 bytes without adding a length prefix.

A write failure may occur after some payload bytes have reached the underlying output.

§Parameters
  • value: UTF-8 string whose bytes are written to the output.
§Returns

Returns after all UTF-8 payload bytes have been written.

§Errors

Returns an I/O error from the underlying output.

Source§

fn write_utf8_string_uleb_usize(&mut self, value: &str) -> Result<(), Error>

Writes the UTF-8 byte length as target-width-dependent unsigned LEB128, followed by the string bytes.

A failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its target-width-dependent byte length.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns an I/O error from writing the prefix or payload.

Source§

fn write_utf8_string_uleb_u64(&mut self, value: &str) -> Result<(), Error>

Writes the UTF-8 byte length as unsigned LEB128 u64, then the string bytes.

Returns InvalidInput if the byte length does not fit in u64; a write failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its u64 byte length.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns InvalidInput if the byte length does not fit in u64, or an I/O error while writing.

Source§

fn write_string_with_u16_len( &mut self, value: &str, byte_order: ByteOrder, ) -> Result<(), Error>

Writes a u16 UTF-8 byte-length prefix in the requested byte order, followed by the string bytes.

Returns InvalidInput if the byte length exceeds u16::MAX; a write failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its u16 byte length.
  • byte_order: Byte order used to encode the length prefix.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns InvalidInput if the byte length exceeds u16::MAX, or an I/O error while writing.

Source§

fn write_string_with_u16_len_be(&mut self, value: &str) -> Result<(), Error>

Writes a big-endian u16 UTF-8 byte-length prefix, then the string bytes.

Returns InvalidInput if the byte length exceeds u16::MAX; a write failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its big-endian u16 byte length.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns InvalidInput if the byte length exceeds u16::MAX, or an I/O error while writing.

Source§

fn write_string_with_u16_len_le(&mut self, value: &str) -> Result<(), Error>

Writes a little-endian u16 UTF-8 byte-length prefix, then the string bytes.

Returns InvalidInput if the byte length exceeds u16::MAX; a write failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its little-endian u16 byte length.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns InvalidInput if the byte length exceeds u16::MAX, or an I/O error while writing.

Source§

fn write_string_with_u32_len( &mut self, value: &str, byte_order: ByteOrder, ) -> Result<(), Error>

Writes a u32 UTF-8 byte-length prefix in the requested byte order, followed by the string bytes.

Returns InvalidInput if the byte length exceeds u32::MAX; a write failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its u32 byte length.
  • byte_order: Byte order used to encode the length prefix.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns InvalidInput if the byte length exceeds u32::MAX, or an I/O error while writing.

Source§

fn write_string_with_u32_len_be(&mut self, value: &str) -> Result<(), Error>

Writes a big-endian u32 UTF-8 byte-length prefix, then the string bytes.

Returns InvalidInput if the byte length exceeds u32::MAX; a write failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its big-endian u32 byte length.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns InvalidInput if the byte length exceeds u32::MAX, or an I/O error while writing.

Source§

fn write_string_with_u32_len_le(&mut self, value: &str) -> Result<(), Error>

Writes a little-endian u32 UTF-8 byte-length prefix, then the string bytes.

Returns InvalidInput if the byte length exceeds u32::MAX; a write failure can leave a partial prefix or payload in the output.

§Parameters
  • value: UTF-8 string to write after its little-endian u32 byte length.
§Returns

Returns after the length prefix and payload have been written.

§Errors

Returns InvalidInput if the byte length exceeds u32::MAX, or an I/O error while writing.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<W> ZigZagWriteExt for W
where W: ByteOutput + ?Sized,

Source§

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

Writes a ZigZag i8. Read more
Source§

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

Writes a ZigZag i16. Read more
Source§

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

Writes a ZigZag i32. Read more
Source§

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

Writes a ZigZag i64. Read more
Source§

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

Writes a ZigZag i128. Read more
Source§

fn write_zig_zag_isize(&mut self, value: isize) -> Result<()>

Writes a ZigZag isize. Read more