Struct Bytes

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

A wrapper around &[u8] to read more efficiently.

This has a specialized implementation of RmpWrite and has error type Infallible.

This has the additional benefit of working on #[no_std] (unlike the builtin Read trait)

See also serde_bytes::Bytes

Unlike a plain &[u8] this also tracks an internal offset in the input (See Self::position).

This is used for (limited) compatibility with std::io::Cursor. Unlike a Cursor it does not support mark/reset.

Implementations

impl<'a> Bytes<'a>

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

Wrap an existing bytes slice.

This sets the internal position to zero.

pub fn remaining_slice(&self) -> &'a [u8]

Get a reference to the remaining bytes in the buffer.

pub fn position(&self) -> u64

Return the position of the input buffer.

This is not required for correctness, it only exists to help mimic Cursor::position

Trait Implementations

impl<'a> Clone for Bytes<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Bytes<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Bytes<'a>

fn default() -> Bytes<'a>

Returns the “default value” for a type.

impl<'a> From<&'a [u8]> for Bytes<'a>

fn from(bytes: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> Hash for Bytes<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Bytes<'a>

fn cmp(&self, other: &Bytes<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Bytes<'a>

fn eq(&self, other: &Bytes<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for Bytes<'a>

fn partial_cmp(&self, other: &Bytes<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RmpRead for Bytes<'_>

type Error = BytesReadError

fn read_u8(&mut self) -> Result<u8, Self::Error>

Read a single (unsigned) byte from this stream

fn read_exact_buf(&mut self, buf: &mut [u8]) -> Result<(), Self::Error>

Read the exact number of bytes needed to fill the specified buffer.

impl<'a> Copy for Bytes<'a>

impl<'a> Eq for Bytes<'a>

impl<'a> StructuralPartialEq for Bytes<'a>