Struct SimpleCursor

pub struct SimpleCursor<'a> { /* private fields */ }

A simple cursor over a slice.

Implementations

impl<'a> SimpleCursor<'a>

pub fn new(collection: &'a [u8]) -> Self

Create a new cursor over a collection.

pub fn read(&mut self, buffer: &mut [u8]) -> usize

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

If this function returns 0 then either:

1. The buffer is of length zero.
2. All bytes have been read from the source.

pub fn read_to_array<const N: usize>(&mut self) -> Result<[u8; N], OutOfBounds>

Pull exactly N bytes from the source into an array.

pub fn read_count<N: Into<usize>>( &mut self, count: N, ) -> Result<&[u8], OutOfBounds>

Pull the next count bytes from the source.

pub fn read_be_integer<const N: usize, I: Integer<N>>( &mut self, ) -> Result<I, OutOfBounds>

Pull N bytes from the source and create a native endian integer value from its representation as a byte array in big endian.

pub fn read_le_integer<const N: usize, I: Integer<N>>( &mut self, ) -> Result<I, OutOfBounds>

Pull N bytes from the source and create a native endian integer value from its representation as a byte array in little endian.

pub fn read_ne_integer<const N: usize, I: Integer<N>>( &mut self, ) -> Result<I, OutOfBounds>

Pull N bytes from the source and create a native endian integer value from its representation as a byte array in native endian.

Trait Implementations

impl<'a> Clone for SimpleCursor<'a>

fn clone(&self) -> SimpleCursor<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for SimpleCursor<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SimpleCursor<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Read for SimpleCursor<'_>

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” adaptor 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.