Struct ZCursor 

pub struct ZCursor<T> {
    pub(crate) stream: T,
    pub(crate) position: usize,
}

Wraps an in memory buffer providing it with a Seek method but works in no_std environments

std::io::Cursor is available in std environments, but we also need support for no_std environments so this serves as a drop in replacement

Fields

stream: T

position: usize

Implementations

impl<T: AsRef<[u8]>> ZCursor<T>

pub fn new(buffer: T) -> ZCursor<T>

impl<T: AsRef<[u8]>> ZCursor<T>

pub fn skip(&mut self, num: usize)

Move forward num bytes from the current position.

It doesn’t check that position overflowed, new position may point past the internal buffer, all subsequent reads will either return an error or zero depending on the method called

pub fn rewind(&mut self, num: usize)

Move back num bytes from the current position

This saturates at zero, it can never be negative or wraparound when the value becomes too small

pub fn split(&self) -> (&[u8], &[u8])

impl<T: AsRef<[u8]>> ZCursor<T>

pub(crate) fn read_byte_no_error_impl(&mut self) -> u8

pub(crate) fn read_exact_bytes_impl( &mut self, buf: &mut [u8], ) -> Result<(), ZByteIoError>

pub(crate) fn read_const_bytes_impl<const N: usize>( &mut self, buf: &mut [u8; N], ) -> Result<(), ZByteIoError>

pub(crate) fn read_const_bytes_no_error_impl<const N: usize>( &mut self, buf: &mut [u8; N], )

pub(crate) fn read_bytes_impl( &mut self, buf: &mut [u8], ) -> Result<usize, ZByteIoError>

pub(crate) fn peek_bytes_impl( &mut self, buf: &mut [u8], ) -> Result<usize, ZByteIoError>

pub(crate) fn peek_exact_bytes_impl( &mut self, buf: &mut [u8], ) -> Result<(), ZByteIoError>

pub(crate) fn z_seek_impl( &mut self, from: ZSeekFrom, ) -> Result<u64, ZByteIoError>

pub(crate) fn is_eof_impl(&mut self) -> Result<bool, ZByteIoError>

pub(crate) fn z_position_impl(&mut self) -> Result<u64, ZByteIoError>

pub(crate) fn read_remaining_impl( &mut self, sink: &mut Vec<u8>, ) -> Result<usize, ZByteIoError>

Trait Implementations

impl<T: AsRef<[u8]>> BufRead for ZCursor<T>

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<T: AsRef<[u8]>> From<T> for ZCursor<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: AsRef<[u8]>> Read for ZCursor<T>

fn read(&mut self, buf: &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<T: AsRef<[u8]>> Seek for ZCursor<T>

fn seek(&mut self, pos: 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.