Struct VariableByteInteger

pub struct VariableByteInteger { /* private fields */ }

MQTT Variable Byte Integer representation with pre-encoded byte buffer.

Implementations

impl VariableByteInteger

pub const MAX: u32 = 268_435_455u32

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

Encode a u32 into 1-4 bytes, return None if too large.

pub fn to_u32(&self) -> u32

Decode back to u32.

pub fn size(&self) -> usize

Number of bytes in the encoding.

pub fn as_bytes(&self) -> &[u8]

Borrow as byte slice.

pub fn to_buffers(&self) -> Vec<IoSlice<'_>>

For scatter-gather I/O.

pub fn decode_stream(buf: &[u8]) -> DecodeResult<Self>

Streaming decode: if enough bytes, returns (vbi, consumed), if too few bytes then Incomplete, else error.

Trait Implementations

impl Clone for VariableByteInteger

fn clone(&self) -> VariableByteInteger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VariableByteInteger

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VariableByteInteger

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VariableByteInteger

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

Formats the value using the given formatter.

impl From<VariableByteInteger> for u32

fn from(vbi: VariableByteInteger) -> Self

Converts to this type from the input type.

impl PartialEq for VariableByteInteger

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

Implementation of PropertySize for VariableByteInteger values Variable byte integers use 1-4 bytes depending on the value

fn size(&self) -> usize

Calculate the encoded size of the property value in bytes

impl Serialize for VariableByteInteger

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u32> for VariableByteInteger

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for VariableByteInteger

impl StructuralPartialEq for VariableByteInteger