Struct MqttTypeAndFlags 

pub struct MqttTypeAndFlags {
    pub message_type: u8,
    pub dup: u8,
    pub qos: u8,
    pub retain: u8,
}

MQTT Fixed Header Type and Flags byte using bebytes for bit field operations

Fields

message_type: u8

Message type (bits 7-4)

dup: u8

DUP flag (bit 3) - for PUBLISH packets

qos: u8

QoS level (bits 2-1) - for PUBLISH packets

retain: u8

RETAIN flag (bit 0) - for PUBLISH packets

Implementations

impl MqttTypeAndFlags

pub fn new(message_type: u8, dup: u8, qos: u8, retain: u8) -> 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 MqttTypeAndFlags

pub fn for_packet_type(packet_type: PacketType) -> Self

Creates a new MqttTypeAndFlags for a given packet type

pub fn for_publish(qos: u8, dup: bool, retain: bool) -> Self

Creates a new MqttTypeAndFlags for PUBLISH packets with QoS and flags

pub fn packet_type(&self) -> Option<PacketType>

Returns the packet type

pub fn is_dup(&self) -> bool

Returns true if the DUP flag is set

pub fn is_retain(&self) -> bool

Returns true if the RETAIN flag is set

Trait Implementations

impl BeBytes for MqttTypeAndFlags

Performance Characteristics

• Expected improvement: 2.3f32x over Vec approach
• Allocation pattern: Single allocation with reuse potential
• Recommendation: Good: Use Bytes buffer methods for better performance

Optimization Hint: Consider using to_be_bytes_buf() for better performance (2.3x improvement)

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 MqttTypeAndFlags

fn clone(&self) -> MqttTypeAndFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttTypeAndFlags

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

Formats the value using the given formatter.

impl PartialEq for MqttTypeAndFlags

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

impl Eq for MqttTypeAndFlags

impl StructuralPartialEq for MqttTypeAndFlags