Struct MqttString 

pub struct MqttString { /* private fields */ }

MQTT string with automatic size handling via BeBytes size expressions

Implementations

impl MqttString

pub fn new(length: u16, data: String) -> Self

pub const fn supports_raw_pointer_encoding() -> bool

Check if this struct supports raw pointer encoding

pub const fn optimal_serialization_method() -> &'static str

Get the optimal serialization method for this struct Returns the method name as a static string for performance guidance

pub fn to_be_bytes_optimal(&self) -> Result<Bytes, BeBytesError>

Automatically select the optimal serialization method (big-endian) This method chooses the best approach based on struct characteristics

pub fn to_le_bytes_optimal(&self) -> Result<Bytes, BeBytesError>

Automatically select the optimal serialization method (little-endian) This method chooses the best approach based on struct characteristics

pub fn create_batch_buffer_be(capacity: usize) -> BytesMut

Create a pre-sized buffer for batch serialization (big-endian) This helps avoid repeated allocations when serializing multiple instances

pub fn create_batch_buffer_le(capacity: usize) -> BytesMut

Create a pre-sized buffer for batch serialization (little-endian) This helps avoid repeated allocations when serializing multiple instances

pub fn encode_be_to_reused( &self, buf: &mut BytesMut, ) -> Result<(), BeBytesError>

Encode to a reusable buffer with optimal method selection (big-endian) This method automatically chooses the best encoding approach for performance

pub fn encode_le_to_reused( &self, buf: &mut BytesMut, ) -> Result<(), BeBytesError>

Encode to a reusable buffer with optimal method selection (little-endian) This method automatically chooses the best encoding approach for performance

impl MqttString

pub fn create(s: &str) -> Result<Self>

Create a new MQTT string

Errors

Returns an error if the string is longer than 65535 bytes

pub fn as_str(&self) -> &str

Get the string value

pub fn encoded_size(&self) -> usize

Get the total encoded size (length field + data)

Trait Implementations

impl BeBytes for MqttString

Performance Characteristics

• Expected improvement: 1f32x over Vec approach
• Allocation pattern: Standard Vec allocation
• Recommendation: Standard: Complex types require Vec approach

Optimization Hint: This struct requires standard serialization methods due to complex field types

fn to_be_bytes_buf(&self) -> Bytes

Convert to big-endian bytes as a zero-copy Bytes buffer

fn to_le_bytes_buf(&self) -> Bytes

Convert to little-endian bytes as a zero-copy Bytes buffer

fn field_size() -> usize

fn try_from_be_bytes(bytes: &[u8]) -> Result<(Self, usize), BeBytesError>

Try to parse a struct from big-endian bytes

fn to_be_bytes(&self) -> Vec<u8>

fn try_from_le_bytes(bytes: &[u8]) -> Result<(Self, usize), BeBytesError>

Try to parse a struct from little-endian bytes

fn to_le_bytes(&self) -> Vec<u8>

fn encode_be_to<B: BufMut>(&self, buf: &mut B) -> Result<(), BeBytesError>

Encode directly to a buffer in big-endian format

fn encode_le_to<B: BufMut>(&self, buf: &mut B) -> Result<(), BeBytesError>

Encode directly to a buffer in little-endian format

impl Clone for MqttString

fn clone(&self) -> MqttString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttString

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

Formats the value using the given formatter.

impl PartialEq for MqttString

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

type Error = MqttError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for MqttString

type Error = MqttError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self>

Performs the conversion.

impl Eq for MqttString

impl StructuralPartialEq for MqttString