Struct VarInt

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

An integer less than 2^62

Values of this type are suitable for encoding as QUIC variable-length integer. It would be neat if we could express to Rust that the top two bits are available for use as enum discriminants

See variable-length integers of QUIC for more details.

Implementations

impl VarInt

pub const MAX: VarInt

The largest representable value

pub const MAX_SIZE: usize = 8usize

The largest encoded value length

pub fn from_u32(x: u32) -> VarInt

Construct a VarInt from a u32.

pub fn from_u64(x: u64) -> Result<VarInt, Overflow>

Construct a VarInt from a u64. Succeeds if x < 2^62.

pub unsafe fn from_u64_unchecked(x: u64) -> VarInt

Create a VarInt from a u64 without ensuring it’s in range

Safety

x must be less than 2^62.

pub fn from_u128(x: u128) -> Result<VarInt, Overflow>

Construct a VarInt from a u128. Succeeds if x < 2^62.

pub fn into_inner(self) -> u64

Extract the integer value

pub fn encoding_size(self) -> usize

Compute the number of bytes needed to encode this value

Trait Implementations

impl Clone for VarInt

fn clone(&self) -> VarInt

Returns a copy 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 Default for VarInt

fn default() -> VarInt

Returns the “default value” for a type.

impl Display for VarInt

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

Formats the value using the given formatter.

impl From<ErrorFrameType> for VarInt

fn from(val: ErrorFrameType) -> VarInt

Converts to this type from the input type.

impl From<ErrorKind> for VarInt

fn from(value: ErrorKind) -> VarInt

Converts to this type from the input type.

impl From<FrameType> for VarInt

fn from(frame_type: FrameType) -> VarInt

Converts to this type from the input type.

impl From<ParameterId> for VarInt

fn from(id: ParameterId) -> VarInt

Converts to this type from the input type.

impl From<StreamId> for VarInt

fn from(s: StreamId) -> VarInt

Converts to this type from the input type.

impl From<VarInt> for StreamId

fn from(v: VarInt) -> StreamId

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<u64> for VarInt

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

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

fn to_usize(&self) -> usize

converts self to usize

impl TryFrom<ParameterValue> for VarInt

type Error = TryIntoError<ParameterValue>

The type returned in the event of a conversion error.

fn try_from( value: ParameterValue, ) -> Result<VarInt, TryIntoError<ParameterValue>>

Performs the conversion.

impl TryFrom<u128> for VarInt

type Error = Overflow

The type returned in the event of a conversion error.

fn try_from(x: u128) -> Result<VarInt, <VarInt as TryFrom<u128>>::Error>

Performs the conversion.

impl TryFrom<u64> for VarInt

fn try_from(x: u64) -> Result<VarInt, <VarInt as TryFrom<u64>>::Error>

Succeeds if x < 2^62

type Error = Overflow

The type returned in the event of a conversion error.

impl TryFrom<usize> for VarInt

fn try_from(x: usize) -> Result<VarInt, <VarInt as TryFrom<usize>>::Error>

Succeeds if x < 2^62

type Error = Overflow

The type returned in the event of a conversion error.

impl Copy for VarInt

impl Eq for VarInt

impl StructuralPartialEq for VarInt