VarInt

Struct VarInt

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

Expand description

noq types that are used in the public iroh API. 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: VarInt

Available on crate feature qlog only.

The largest representable value

pub const MAX_SIZE: usize = 8usize

Available on crate feature qlog only.

The largest encoded value length

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

Available on crate feature qlog only.

Construct a VarInt infallibly

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

Available on crate feature qlog only.

Succeeds iff x < 2^62

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

Available on crate feature qlog only.

Create a VarInt without ensuring it’s in range

§Safety

x must be less than 2^62.

pub const fn into_inner(self) -> u64

Available on crate feature qlog only.

Extract the integer value

pub fn saturating_add(self, rhs: impl Into<VarInt>) -> VarInt

Available on crate feature qlog only.

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Trait Implementations§

impl Clone for VarInt

fn clone(&self) -> VarInt

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for VarInt

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

Formats the value using the given formatter. Read more

impl Decodable for VarInt

fn decode<B>(r: &mut B) -> Result<VarInt, UnexpectedEnd>
where B: Buf,

Decode a Self from the provided buffer, if the buffer is large enough

impl Default for VarInt

fn default() -> VarInt

Returns the “default value” for a type. Read more

impl Display for VarInt

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

Formats the value using the given formatter. Read more

impl Encodable for VarInt

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

Append the encoding of self to the provided buffer.

impl From<FrameType> for VarInt

fn from(value: FrameType) -> VarInt

Converts to this type from the input type.

impl From<StreamId> for VarInt

fn from(x: StreamId) -> VarInt

Converts to this type from the input type.

impl From<Code> for VarInt

fn from(value: Code) -> VarInt

Converts to this type from the input type.

impl From<VarInt> for IdleTimeout

fn from(inner: VarInt) -> IdleTimeout

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

fn from(value: VarInt) -> Code

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. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl Ord for VarInt

fn cmp(&self, other: &VarInt) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

impl PartialEq for VarInt

fn eq(&self, other: &VarInt) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl TryFrom<u128> for VarInt

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

Succeeds iff 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<VarInt, VarIntBoundsExceeded>

Succeeds iff 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<VarInt, VarIntBoundsExceeded>

Succeeds iff 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

Auto Trait Implementations§

impl Freeze for VarInt

impl RefUnwindSafe for VarInt

impl Send for VarInt

impl Sync for VarInt

impl Unpin for VarInt

impl UnwindSafe for VarInt

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,