VariableByteInteger

Struct VariableByteInteger 

Source
pub struct VariableByteInteger { /* private fields */ }
Expand description

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

Implementations§

Source§

impl VariableByteInteger

Source

pub const MAX: u32 = 268_435_455u32

Source

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

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

Source

pub fn to_u32(&self) -> u32

Decode back to u32.

Source

pub fn size(&self) -> usize

Number of bytes in the encoding.

Source

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

Borrow as byte slice.

Source

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

For scatter-gather I/O.

Source

pub fn to_continuous_buffer(&self) -> Vec<u8>

Create a continuous buffer containing the complete packet data

Returns a vector containing all packet bytes in a single continuous buffer. This method is compatible with no-std environments and provides an alternative to to_buffers() when vectored I/O is not needed.

Source

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§

Source§

impl Clone for VariableByteInteger

Source§

fn clone(&self) -> VariableByteInteger

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

impl Debug for VariableByteInteger

Source§

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

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

impl Display for VariableByteInteger

Source§

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

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

impl From<VariableByteInteger> for u32

Source§

fn from(vbi: VariableByteInteger) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for VariableByteInteger

Source§

fn eq(&self, other: &VariableByteInteger) -> 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.
Source§

impl PropertySize for VariableByteInteger

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

Source§

fn size(&self) -> usize

Calculate the encoded size of the property value in bytes Read more
Source§

impl Serialize for VariableByteInteger

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<u32> for VariableByteInteger

Source§

type Error = &'static str

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

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

Performs the conversion.
Source§

impl Eq for VariableByteInteger

Source§

impl StructuralPartialEq for VariableByteInteger

Auto Trait Implementations§

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

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

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

Source§

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

Compare self to key and return true if they are equal.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

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

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.