Struct ZigZagReader 

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

Reader wrapper for ZigZag encoded signed integers.

This wrapper defaults to non-strict decoding of the underlying unsigned LEB128 value. Use ZigZagReader::with_strict or ZigZagReader::set_strict to reject non-canonical underlying encodings.

Examples

use std::io::Cursor;

use qubit_io::{
    ZigZagReader,
    ZigZagWriter,
};

let mut output = ZigZagWriter::new(Vec::new());
output.write_i32(-123)?;

let mut input = ZigZagReader::with_strict(Cursor::new(output.into_inner()), true);
assert_eq!(-123, input.read_i32()?);

Implementations

impl<R> ZigZagReader<R>

pub fn new(inner: R) -> Self

Creates a ZigZag reader.

Parameters

• inner: Reader to wrap.

Returns

A new non-strict ZigZag reader.

pub fn with_strict(inner: R, strict: bool) -> Self

Creates a ZigZag reader with explicit underlying LEB128 policy.

Parameters

• inner: Reader to wrap.
• strict: Whether to reject non-canonical underlying LEB128 encodings.

Returns

A new ZigZag reader.

pub fn is_strict(&self) -> bool

Reports whether strict underlying LEB128 decoding is enabled.

Returns

true when non-canonical underlying LEB128 encodings are rejected.

pub fn set_strict(&mut self, strict: bool)

Changes the underlying LEB128 policy used by subsequent reads.

Parameters

• strict: Whether to reject non-canonical underlying LEB128 encodings.

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.

impl<R> ZigZagReader<R>

where R: Read,

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

Reads a ZigZag encoded i8.

Errors

Returns an I/O error from the wrapped reader, or InvalidData for malformed or overflowing underlying unsigned LEB128 input. In strict mode, also returns InvalidData for non-canonical underlying LEB128 input.

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

Reads a ZigZag encoded i16.

Errors

Returns an I/O error from the wrapped reader, or InvalidData for malformed or overflowing underlying unsigned LEB128 input. In strict mode, also returns InvalidData for non-canonical underlying LEB128 input.

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

Reads a ZigZag encoded i32.

Errors

Returns an I/O error from the wrapped reader, or InvalidData for malformed or overflowing underlying unsigned LEB128 input. In strict mode, also returns InvalidData for non-canonical underlying LEB128 input.

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

Reads a ZigZag encoded i64.

Errors

Returns an I/O error from the wrapped reader, or InvalidData for malformed or overflowing underlying unsigned LEB128 input. In strict mode, also returns InvalidData for non-canonical underlying LEB128 input.

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

Reads a ZigZag encoded i128.

Errors

Returns an I/O error from the wrapped reader, or InvalidData for malformed or overflowing underlying unsigned LEB128 input. In strict mode, also returns InvalidData for non-canonical underlying LEB128 input.

pub fn read_isize(&mut self) -> Result<isize>

Reads a ZigZag encoded isize.

Errors

Returns an I/O error from the wrapped reader, or InvalidData for malformed or overflowing underlying unsigned LEB128 input. In strict mode, also returns InvalidData for non-canonical underlying LEB128 input.

Trait Implementations

impl<R> BufRead for ZigZagReader<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 ZigZagReader<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 ZigZagReader<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.