Struct VarU16 

pub struct VarU16 { /* private fields */ }

A variable-width encoded u16.

VarU16 encodes a 16-bit unsigned integer in a compact form, where the number of bytes required depends on the value being stored. Small values fit into a single byte, while larger values require two bytes.

This encoding scheme reserves the most significant bit of the first byte as a flag, indicating the size of the type:

• If MSB is 0, the value fits in one byte.
• If MSB is 1, the value is stored across two bytes.

Invariants

• Encoded values fit into 15 bits (value <= u16::MAX >> 1).

Implementations

impl VarU16

pub fn new(value: u16) -> Self

Creates a new VarU16.

Panics

Panics if the given value exceeds the maximum encodable range (value > u16::MAX >> 1).

pub const fn try_new(value: u16) -> Result<Self, VarU16SizeError>

Tries to create a new VarU16.

Errors

Returns a VarU16SizeError if the given value exceeds the maximum encodable range (value > u16::MAX >> 1).

pub fn into_inner(self) -> u16

Returns the inner raw u16 value.

pub fn check_wide(first: u8) -> bool

Checks whether the given first byte indicates a wide (two-byte) value.

Trait Implementations

impl Clone for VarU16

fn clone(&self) -> VarU16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VarU16

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

Formats the value using the given formatter.

impl Decode for VarU16

fn decode(data: &mut &[u8]) -> Result<Self, DecodeError>

Attempts to decode Self from the beginning of the provided byte slice.

impl Encode for VarU16

fn size(&self) -> usize

Returns the number of bytes this value will take when encoded.

fn encode(&self, data: &mut [u8])

Encodes this instance into the provided byte slice.

impl Hash for VarU16

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 VarU16

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

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

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

impl Eq for VarU16

impl StructuralPartialEq for VarU16