Struct Byte

pub struct Byte(pub u8);

Wrapper for a byte of information. It differs from an u8 on how it is deserialized. A Byte reads exactly one byte from the input iterator, while a u8 could potentially read several bytes (since unsigned integers are encoded using LEB-128).

A Byte takes exactly one byte of memory, and can be transmuted to u8. This is specially useful since it allows transmuting a vector of Bytes to a vector of u8.

Example

let mut iter = [0x8E].iter().copied();
let Byte(result) = deserialize(&mut iter).unwrap();
assert_eq!(result, 0x8E);

Deserialization will return an error if the iterator is exhausted while deserializing.

let mut iter = [0x00].iter().copied();
let Byte(_) = deserialize(&mut iter).unwrap();
let result: Result<Byte> = deserialize(&mut iter);
assert!(result.is_err());

Tuple Fields

0: u8

Trait Implementations

impl Clone for Byte

fn clone(&self) -> Byte

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Byte

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

Formats the value using the given formatter.

impl Display for Byte

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

Formats the value using the given formatter.

impl Grammar for Byte

fn deserialize<Iter: Iterator<Item = u8>>(iter: &mut Iter) -> Result<Self>

Read a Byte from an Iterator<u8>. It returns Ok(Byte(_)) on success, and Error(Error::UnexpectedEndOfStream) if the iterator returns None.

Deserializing a Byte instead of using iter.next() is an easy way to convert the Option<u8> returned by the iterator into a Result<u8> with a meaningful error type.

impl Hash for Byte

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 Ord for Byte

fn cmp(&self, other: &Byte) -> 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 PartialEq<char> for Byte

fn eq(&self, other: &char) -> 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 PartialEq<u8> for Byte

fn eq(&self, other: &u8) -> 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 PartialEq for Byte

fn eq(&self, other: &Byte) -> 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 PartialOrd for Byte

fn partial_cmp(&self, other: &Byte) -> 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 Copy for Byte

impl Eq for Byte

impl StructuralPartialEq for Byte