Struct Vbi 

pub struct Vbi(u32);

Variable Byte Integer (VBI) as defined in MQTT v5 §1.5.5.

Tuple Fields

0: u32

Implementations

impl Vbi

pub const MIN: Self

The minimum value.

pub const MAX: Self

The maximum value.

pub const BITS: u32 = 28u32

The number of bits needed to represent the maximum value.

pub const MAX_USIZE: usize = 268_435_455usize

The maximum usize value that can be represented as a VBI.

pub const unsafe fn new_unchecked(value: u32) -> Self

Creates a new VBI from the given value without checking that it’s in range.

Safety

The caller must guarantee that value is at most Vbi::MAX.

pub const fn new(value: u32) -> Option<Self>

Creates a new VBI from the given value, returning None if the value is out of range.

pub const fn from_u16(value: u16) -> Self

Creates a new VBI from a u16, which is always valid.

pub const fn from_u8(value: u8) -> Self

Creates a new VBI from a u8, which is always valid.

pub const fn get(self) -> u32

Returns the raw value of this VBI.

pub const fn encoded_len(self) -> usize

Returns the number of bytes needed to encode this VBI.

Trait Implementations

impl Clone for Vbi

fn clone(&self) -> Vbi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vbi

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

Formats the value using the given formatter.

impl Default for Vbi

fn default() -> Vbi

Returns the “default value” for a type.

impl Hash for Vbi

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 Vbi

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

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

fn partial_cmp(&self, other: &Vbi) -> 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 Copy for Vbi

impl Eq for Vbi

impl StructuralPartialEq for Vbi