Struct VarInt

pub struct VarInt(/* private fields */);

An integer less than 2^62

Based on QUIC variable-length integers (RFC 9000).

The QUIC variable-length integer encoding reserves the two most significant bits of the first byte to encode the base-2 logarithm of the integer encoding length in bytes. The integer value is encoded on the remaining bits, in network byte order. This means that integers are encoded on 1, 2, 4, or 8 bytes and can encode 6-, 14-, 30-, or 62-bit values, respectively. Table 4 summarizes the encoding properties.

MSB   Length   Usable Bits   Range
----------------------------------------------------
00    1        6             0 - 63
01    2        14            0 - 16383
10    4        30            0 - 1073741823
11    8        62            0 - 4611686018427387903

Implementations

impl VarInt

pub const MAX: VarInt

The largest representable value.

pub fn new(x: u64) -> Result<VarInt, BoundsExceeded>

Succeeds iff x < 2^62.

pub fn new_unchecked(x: u64) -> VarInt

Methods from Deref<Target = u64>

pub const MIN: u64 = 0u64

pub const MAX: u64 = 18_446_744_073_709_551_615u64

pub const BITS: u32 = 64u32

Trait Implementations

impl Clone for VarInt

fn clone(&self) -> VarInt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VarInt

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

Formats the value using the given formatter.

impl Decode for VarInt

fn decode(buf: &mut impl Buf) -> Result<VarInt, Error>

impl Default for VarInt

fn default() -> VarInt

Returns the “default value” for a type.

impl Deref for VarInt

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &<VarInt as Deref>::Target

Dereferences the value.

impl Display for VarInt

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

Formats the value using the given formatter.

impl Encode for VarInt

fn encode(&self, w: &mut impl BufMut)

impl From<StreamId> for VarInt

fn from(value: StreamId) -> VarInt

Converts to this type from the input type.

impl From<u16> for VarInt

fn from(x: u16) -> VarInt

Converts to this type from the input type.

impl From<u32> for VarInt

fn from(x: u32) -> VarInt

Converts to this type from the input type.

impl From<u8> for VarInt

fn from(x: u8) -> VarInt

Converts to this type from the input type.

impl Hash for VarInt

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

where __H: Hasher,

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 VarInt

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

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

fn partial_cmp(&self, other: &VarInt) -> 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 TryFrom<u64> for VarInt

fn try_from(x: u64) -> Result<VarInt, BoundsExceeded>

Succeeds iff x < 2^62.

type Error = BoundsExceeded

The type returned in the event of a conversion error.

impl Copy for VarInt

impl Eq for VarInt

impl StructuralPartialEq for VarInt