Struct VarByteInt 

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

MQTT’s variable byte integer encoding. The value has to be less than VarByteInt::MAX_ENCODABLE (268_435_455). Exceeding this ultimately leads to panics or malformed packets.

Used for packet length and some properties.

Use its TryFrom (u32) and From (u16, u8) implementations to construct a value.

Implementations

impl VarByteInt

pub const MAX_ENCODABLE: u32 = 268_435_455

The maximum encodable value using the variable byte integer encoding according to https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901011.

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

Creates a variable byte integer by checking for the maximum value of VarByteInt::MAX_ENCODABLE. For a version accepting u16 and u8, use From::from.

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

Creates a variable byte integer without checking for the maximum value of VarByteInt::MAX_ENCODABLE. For a fallible version, use VarByteInt::new. For an infallible version accepting u16 and u8, use From::from.

Invariants

The value parameter must be less than or equal to VarByteInt::MAX_ENCODABLE.

Panics

Panics in debug builds if value exceeds VarByteInt::MAX_ENCODABLE.

pub const fn value(&self) -> u32

Returns the inner value.

pub const fn size(&self) -> usize

Returns Self::value as usize.

Trait Implementations

impl Clone for VarByteInt

fn clone(&self) -> VarByteInt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VarByteInt

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

Formats the value using the given formatter.

impl From<u16> for VarByteInt

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u8> for VarByteInt

fn from(value: u8) -> Self

Converts to this type from the input type.

impl PartialEq for VarByteInt

fn eq(&self, other: &VarByteInt) -> 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 TryFrom<u32> for VarByteInt

type Error = TooLargeToEncode

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for VarByteInt

impl Eq for VarByteInt

impl StructuralPartialEq for VarByteInt