Skip to main content

Varint

Struct Varint 

Source
pub struct Varint<T>(pub T);
Expand description

LEB128 varint wrapper. Signed integers use the zigzag mapping, matching protobuf’s sint32 / sint64.

Decoding is lenient about overlong encodings, like varint::decode_u64. Call the varint::decode_*_canonical functions directly when canonical form must be enforced.

§Example

use wire_codec::{Decode, Encode, ReadBuf, Varint, WriteBuf};

let mut out = [0u8; 8];
let mut buf = WriteBuf::new(&mut out);
Varint(300_u32).encode(&mut buf).unwrap();
Varint(-1_i64).encode(&mut buf).unwrap();
assert_eq!(buf.written(), &[0xAC, 0x02, 0x01]);
assert_eq!(Varint(300_u32).encoded_size(), 2);

let mut r = ReadBuf::new(&out[..3]);
assert_eq!(Varint::<u32>::decode(&mut r).unwrap(), Varint(300));
assert_eq!(Varint::<i64>::decode(&mut r).unwrap(), Varint(-1));

Tuple Fields§

§0: T

Trait Implementations§

Source§

impl<T: Clone> Clone for Varint<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy> Copy for Varint<T>

Source§

impl<T: Debug> Debug for Varint<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Decode<'de> for Varint<u16>

Source§

fn decode(buf: &mut ReadBuf<'de>) -> Result<Self>

Read a value of Self from buf, advancing its read position. Read more
Source§

impl<'de> Decode<'de> for Varint<u32>

Source§

fn decode(buf: &mut ReadBuf<'de>) -> Result<Self>

Read a value of Self from buf, advancing its read position. Read more
Source§

impl<'de> Decode<'de> for Varint<u64>

Source§

fn decode(buf: &mut ReadBuf<'de>) -> Result<Self>

Read a value of Self from buf, advancing its read position. Read more
Source§

impl<'de> Decode<'de> for Varint<usize>

Source§

fn decode(buf: &mut ReadBuf<'de>) -> Result<Self>

Read a value of Self from buf, advancing its read position. Read more
Source§

impl<'de> Decode<'de> for Varint<i32>

Source§

fn decode(buf: &mut ReadBuf<'de>) -> Result<Self>

Read a value of Self from buf, advancing its read position. Read more
Source§

impl<'de> Decode<'de> for Varint<i64>

Source§

fn decode(buf: &mut ReadBuf<'de>) -> Result<Self>

Read a value of Self from buf, advancing its read position. Read more
Source§

impl<T: Default> Default for Varint<T>

Source§

fn default() -> Self

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

impl Encode for Varint<u16>

Source§

fn encoded_size(&self) -> usize

Number of bytes Encode::encode will write on success.
Source§

fn encode(&self, buf: &mut WriteBuf<'_>) -> Result<()>

Write self into buf, advancing its write position. Read more
Source§

impl Encode for Varint<u32>

Source§

fn encoded_size(&self) -> usize

Number of bytes Encode::encode will write on success.
Source§

fn encode(&self, buf: &mut WriteBuf<'_>) -> Result<()>

Write self into buf, advancing its write position. Read more
Source§

impl Encode for Varint<u64>

Source§

fn encoded_size(&self) -> usize

Number of bytes Encode::encode will write on success.
Source§

fn encode(&self, buf: &mut WriteBuf<'_>) -> Result<()>

Write self into buf, advancing its write position. Read more
Source§

impl Encode for Varint<usize>

Source§

fn encoded_size(&self) -> usize

Number of bytes Encode::encode will write on success.
Source§

fn encode(&self, buf: &mut WriteBuf<'_>) -> Result<()>

Write self into buf, advancing its write position. Read more
Source§

impl Encode for Varint<i32>

Source§

fn encoded_size(&self) -> usize

Number of bytes Encode::encode will write on success.
Source§

fn encode(&self, buf: &mut WriteBuf<'_>) -> Result<()>

Write self into buf, advancing its write position. Read more
Source§

impl Encode for Varint<i64>

Source§

fn encoded_size(&self) -> usize

Number of bytes Encode::encode will write on success.
Source§

fn encode(&self, buf: &mut WriteBuf<'_>) -> Result<()>

Write self into buf, advancing its write position. Read more
Source§

impl<T: Eq> Eq for Varint<T>

Source§

impl<T: Hash> Hash for Varint<T>

Source§

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

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
Source§

impl<T: Ord> Ord for Varint<T>

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl<T: PartialEq> PartialEq for Varint<T>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<T: PartialOrd> PartialOrd for Varint<T>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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
Source§

impl<T: PartialEq> StructuralPartialEq for Varint<T>

Auto Trait Implementations§

§

impl<T> Forget for Varint<T>

§

impl<T> Freeze for Varint<T>
where T: Freeze,

§

impl<T> Move for Varint<T>

§

impl<T> RefUnwindSafe for Varint<T>
where T: RefUnwindSafe,

§

impl<T> Send for Varint<T>
where T: Send,

§

impl<T> Sync for Varint<T>
where T: Sync,

§

impl<T> Unpin for Varint<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Varint<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Varint<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.