Struct wire_rs::VectoredCursor

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

A cursor that acts as an index over a set of vectored immutable slices and provides operations to sequentially read data from the slices.

When implementing the VectoredRead trait or one of its variants, this cursor provides an interface for reading data from the vectored wire. When an error is returned by the cursor, it should be returned by the trait method being implemented. This can be easily accomplished using the ? operator.

NOTE: this is an internal structure, and is NOT meant to be used to read data from a wire in the same manner as a WireReader. A WireReader is guaranteed to maintain the index of its last succesful read if any of its methods return an error, while this cursor may move its internal index forward by some unspecified amount when an error is encountered.

Implementations

impl<'a> VectoredCursor<'a>

pub fn advance(&mut self, amount: usize) -> Result<(), WireError>

Advance the cursor’s index by the given amount, returning an error if there are insufficient bytes on the vectored wire.

pub fn advance_up_to(&mut self, amount: usize)

Advance the cursor’s index by the given amount, or to the end of the vectored wire if the amount exceeds the number of remaining bytes.

pub fn is_empty(&self) -> bool

Check whether the vectored wire has any remaining bytes that can be read by the cursor.

pub fn get_next(&mut self) -> Result<u8, WireError>

Retrieve a the next available byte from the wire.

pub fn get_readable<T, const E: bool>(&mut self) -> Result<T, WireError>where
    T: VectoredRead,

Deserialize a given type T that implements the VectoredRead trait from the vectored wire, and return an owned instance of it.

The generic boolean E designates the intended endianness of the data being read. If E is set to true, then the data will be deserialized in big endian format; if false, it will be deserialized in little endian.

pub fn get_readable_part<T, const L: usize, const E: bool>(
    &mut self
) -> Result<T, WireError>where
    T: VectoredReadPart,

Deserialize L bytes from the vectored wire into a given type T that implements the VectoredReadPart trait, and return an owned instance of it.

The generic boolean E designates the intended endianness of the data being read. If E is set to true, then the data will be deserialized in big endian format; if false, it will be deserialized in little endian.

pub fn get_readable_ref<T, const E: bool>(
    &mut self,
    length: usize
) -> Result<&'a T, WireError>where
    T: VectoredReadRef + ?Sized,

Deserialize a given type T that implements the VectoredReadRef trait from the vectored wire, and return a reference to it.

The generic boolean E designates the intended endianness of the data being read. If E is set to true, then the data will be deserialized in big endian format; if false, it will be deserialized in little endian.

pub fn get_readable_comp<T, const E: bool>(&mut self) -> Result<T, WireError>where
    T: VectoredReadComp<'a> + ?Sized,

Deserialize a given type T that implements the VectoredReadComp trait from the wire, and return an owned instance of it.

The generic boolean E designates the intended endianness of the data being read. If E is set to true, then the data will be deserialized in big endian format; if false, it will be deserialized in little endian.

pub fn remaining(&self) -> usize

Get the number of bytes remaining on the vectored wire for the given cursor.

pub fn try_get(&mut self, amount: usize) -> Option<&'a [u8]>

Attempt to retrieve a contiguous slice of bytes from the wire, returning None if the next amount bytes are not all located on the same slice.

pub fn try_get_array<const L: usize>(&mut self) -> Option<&'a [u8; L]>

Attempt to retrieve a reference to a contiguous array of bytes of size L from the wire, returning None if the next L bytes are not all located on the same slice.

Trait Implementations

impl<'a> Clone for VectoredCursor<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for VectoredCursor<'a>