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.

Implementations

impl VarInt

pub const MAX: Self

The largest representable value.

pub const MAX_SIZE: usize = 8

The largest encoded value length.

pub const fn from_u32(x: u32) -> Self

Construct a VarInt infallibly.

pub fn from_u64(x: u64) -> Result<Self, VarIntBoundsExceeded>

Succeeds if x < 2^62.

pub const unsafe fn from_u64_unchecked(x: u64) -> Self

Create a VarInt without checking the bounds.

Safety

x must be less than 2^62.

pub const fn into_inner(self) -> u64

Extract the integer value.

pub fn size(self) -> usize

Compute the number of bytes needed to encode this value.

impl VarInt

pub fn decode<B: Buf>(r: &mut B) -> Result<Self, VarIntUnexpectedEnd>

Decode a QUIC varint from an in-memory buffer.

pub async fn read<S: AsyncRead + Unpin>( stream: &mut S, ) -> Result<Self, VarIntUnexpectedEnd>

Read a QUIC varint from an async stream.

pub fn encode<B: BufMut>(&self, w: &mut B)

Encode this value as a QUIC varint into the given buffer.

pub async fn write<S: AsyncWrite + Unpin>( &self, stream: &mut S, ) -> Result<(), VarIntUnexpectedEnd>

Encode and write this value as a QUIC varint to an async stream.

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

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

Formats the value using the given formatter.

impl From<VarInt> for u64

fn from(x: VarInt) -> Self

Converts to this type from the input type.

impl From<u16> for VarInt

fn from(x: u16) -> Self

Converts to this type from the input type.

impl From<u32> for VarInt

fn from(x: u32) -> Self

Converts to this type from the input type.

impl From<u8> for VarInt

fn from(x: u8) -> Self

Converts to this type from the input type.

impl Hash for VarInt

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

fn try_from(x: u128) -> Result<Self, VarIntBoundsExceeded>

Succeeds if x < 2^62.

type Error = VarIntBoundsExceeded

The type returned in the event of a conversion error.

impl TryFrom<u64> for VarInt

fn try_from(x: u64) -> Result<Self, VarIntBoundsExceeded>

Succeeds if x < 2^62.

type Error = VarIntBoundsExceeded

The type returned in the event of a conversion error.

impl TryFrom<usize> for VarInt

fn try_from(x: usize) -> Result<Self, VarIntBoundsExceeded>

Succeeds if x < 2^62.

type Error = VarIntBoundsExceeded

The type returned in the event of a conversion error.

impl Copy for VarInt

impl Eq for VarInt

impl StructuralPartialEq for VarInt