Struct PingReqPacket 

pub struct PingReqPacket { /* private fields */ }

MQTT PINGREQ packet - complete bebytes implementation

Implementations

impl PingReqPacket

pub const RAW_POINTER_SIZE: usize = 2usize

Get the compile-time known size of this struct

pub fn new(fixed_header: u16) -> Self

pub const fn supports_raw_pointer_encoding() -> bool

Check if this struct supports raw pointer encoding

pub fn encode_be_to_raw_stack(&self) -> [u8; 2]

Encode to a stack-allocated array using raw pointer operations (big-endian) This is the fastest possible encoding method with zero allocations

Compile-time Safety

The array size is determined at compile time based on struct fields.

pub fn encode_le_to_raw_stack(&self) -> [u8; 2]

Encode to a stack-allocated array using raw pointer operations (little-endian) This is the fastest possible encoding method with zero allocations

Compile-time Safety

The array size is determined at compile time based on struct fields.

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

Encode directly to a mutable buffer using raw pointer operations (big-endian) This method is unsafe and requires the buffer to have sufficient capacity

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

Encode directly to a mutable buffer using raw pointer operations (little-endian) This method is unsafe and requires the buffer to have sufficient capacity

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 PingReqPacket

pub const FIXED_HEADER: u16 = 49_152u16

The fixed header value for PINGREQ packets

impl PingReqPacket

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

Encode directly to bytes using bebytes

pub fn decode_complete(data: &[u8]) -> Result<Self>

Decode directly from bytes using bebytes

Errors

Returns an error if:

• Insufficient bytes in data
• Invalid PINGREQ packet structure
• Fixed header doesn’t match expected PINGREQ values

Trait Implementations

impl BeBytes for PingReqPacket

Performance Characteristics

• Expected improvement: 5.4f32x over Vec approach
• Allocation pattern: Zero allocations (stack only)
• Recommendation: Optimal: Use raw pointer methods for maximum performance

Optimization Hint: Consider using encode_be_to_raw_stack() for maximum performance (5.4x improvement)

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 to_be_bytes_buf(&self) -> Bytes

Convert to big-endian bytes as a Bytes buffer

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 to_le_bytes_buf(&self) -> Bytes

Convert to little-endian bytes as a Bytes buffer

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 PingReqPacket

fn clone(&self) -> PingReqPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PingReqPacket

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

Formats the value using the given formatter.

impl Default for PingReqPacket

fn default() -> Self

Returns the “default value” for a type.

impl MqttPacket for PingReqPacket

fn packet_type(&self) -> PacketType

Returns the packet type

fn encode_body<B: BufMut>(&self, _buf: &mut B) -> Result<()>

Encodes the packet body (without fixed header)

fn decode_body<B: Buf>( _buf: &mut B, _fixed_header: &FixedHeader, ) -> Result<Self>

Decodes the packet body (without fixed header)

fn flags(&self) -> u8

Returns the fixed header flags

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

Encodes the complete packet (with fixed header)

impl PartialEq for PingReqPacket

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

impl Eq for PingReqPacket

impl StructuralPartialEq for PingReqPacket