Skip to main content

BufferedZigZagWriter

Struct BufferedZigZagWriter 

Source
pub struct BufferedZigZagWriter<W>
where W: Output<Item = u8>,
{ /* private fields */ }
Expand description

Buffered writer for canonical ZigZag + unsigned LEB128 integers.

Values are encoded directly into the internal output buffer and flushed to the wrapped writer in larger chunks.

§Flush contract

Dropping this writer delegates to qubit_io::BufferedOutput, which makes a best-effort attempt to drain pending bytes, ignores drop-time errors, and does not guarantee that the wrapped writer itself is flushed. Call Output::flush to guarantee that all bytes reach the wrapped output. Self::inner can observe the wrapped writer before pending bytes have been flushed.

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

Implementations§

Source§

impl<W> BufferedZigZagWriter<W>
where W: Output<Item = u8>,

Source

pub fn new(inner: W) -> Self

Creates a buffered ZigZag writer with the default buffer capacity.

§Parameters
  • inner: Underlying byte output.
§Returns

Returns a buffered canonical ZigZag writer.

Source

pub fn with_capacity(inner: W, capacity: usize) -> Self

Creates a buffered ZigZag writer with at least capacity bytes.

§Parameters
  • inner: Underlying byte output.
  • capacity: Requested internal buffer capacity in bytes.
§Returns

Returns a buffered writer whose capacity also satisfies the largest supported codec payload.

Source

pub fn try_with_capacity( inner: W, capacity: usize, ) -> Result<Self, TryReserveError>

Tries to create a buffered ZigZag writer with at least capacity bytes.

§Errors

Returns an allocation error when the requested buffer cannot be allocated.

Source

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

Returns a shared reference to the underlying writer.

Pending bytes may still be held in this wrapper’s internal buffer.

§Returns

Returns the wrapped writer.

Source

pub fn into_parts(self) -> (W, Buffer<u8>)

Provides access to the underlying writer.

Direct writes through the returned writer bypass pending bytes in this wrapper and can reorder the physical byte stream. Flush this wrapper before using the returned writer directly.

Returns the underlying writer and every encoded byte still pending.

This method does not call Self::flush and performs no I/O. Call Self::flush first for normal completion; a successful flush leaves the returned buffer empty. Otherwise, the returned buffer transfers responsibility for pending bytes to the caller.

§Returns

Returns the wrapped writer and pending bytes in logical write order.

Source§

impl<W> BufferedZigZagWriter<W>
where W: Output<Item = u8>,

Source

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

Writes a ZigZag i8.

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

Returns after the canonical payload has been accepted.

§Errors

Returns an output error encountered while making buffer space.

Source

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

Writes a ZigZag i16.

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

Returns after the canonical payload has been accepted.

§Errors

Returns an output error encountered while making buffer space.

Source

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

Writes a ZigZag i32.

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

Returns after the canonical payload has been accepted.

§Errors

Returns an output error encountered while making buffer space.

Source

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

Writes a ZigZag i64.

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

Returns after the canonical payload has been accepted.

§Errors

Returns an output error encountered while making buffer space.

Source

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

Writes a ZigZag i128.

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

Returns after the canonical payload has been accepted.

§Errors

Returns an output error encountered while making buffer space.

Source

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

Writes a ZigZag isize.

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

Returns after the canonical payload has been accepted.

§Errors

Returns an output error encountered while making buffer space.

Source§

impl<W> BufferedZigZagWriter<W>
where W: Output<Item = u8>,

Source

pub fn is_buffered(&self) -> bool

Returns whether this writer buffers output.

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.

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

Source

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

Writes all bytes from an indexed input range.

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

Source

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

Flushes buffered output.

Source§

impl<W> BufferedZigZagWriter<W>
where W: Output<Item = u8> + Seekable<Unit = u8>,

Source

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

Seeks the wrapped byte stream.

Trait Implementations§

Source§

impl<W> Output for BufferedZigZagWriter<W>
where W: Output<Item = u8>,

Source§

fn is_buffered(&self) -> bool

Reports that this adapter buffers output.

§Returns

Always returns true.

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

§Errors

Returns an output error encountered while draining pending bytes.

§Safety

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

Source§

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

Flushes the internal buffer and then the wrapped writer.

§Returns

Returns after buffered and wrapped output have flushed.

§Errors

Returns an error encountered while draining or flushing.

Source§

type Item = u8

The item type written to this output.
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§

impl<W> Seekable for BufferedZigZagWriter<W>
where W: Output<Item = u8> + Seekable<Unit = u8>,

Source§

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

Flushes pending bytes before seeking the wrapped writer.

§Parameters
  • position: Target seek position.
§Returns

Returns the new physical stream position.

§Errors

Returns an error encountered while flushing or seeking.

Source§

type Unit = u8

The unit type used to measure seek positions and offsets.

Auto Trait Implementations§

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: Output<Item = u8> + ?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> 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: Output<Item = u8> + ?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> SeekableOutput for T
where T: Output + Seekable<Unit = <T as Output>::Item>,

Source§

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

Source§

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

Writes a UTF-8 payload without a length prefix. Read more
Source§

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

Writes a UTF-8 string with an unsigned LEB128 byte-length prefix. Read more
Source§

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

Writes a UTF-8 string with an unsigned LEB128 u64 byte-length prefix. Read more
Source§

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

Writes a UTF-8 string with a runtime-order u16 byte-length prefix. Read more
Source§

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

Writes a UTF-8 string with a big-endian u16 byte-length prefix. Read more
Source§

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

Writes a UTF-8 string with a little-endian u16 byte-length prefix. Read more
Source§

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

Writes a UTF-8 string with a runtime-order u32 byte-length prefix. Read more
Source§

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

Writes a UTF-8 string with a big-endian u32 byte-length prefix. Read more
Source§

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

Writes a UTF-8 string with a little-endian u32 byte-length prefix. Read more
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, <T as TryFrom<U>>::Error>

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: Output<Item = u8> + ?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