AckPacketHeader

Struct AckPacketHeader 

Source
pub struct AckPacketHeader {
    pub packet_id: u16,
    pub reason_code: u8,
}
Expand description

MQTT acknowledgment packet variable header using bebytes Used by PubAck, PubRec, PubRel, and PubComp packets

Fields§

§packet_id: u16

Packet identifier

§reason_code: u8

Reason code (single byte)

Implementations§

Source§

impl AckPacketHeader

Source

pub const RAW_POINTER_SIZE: usize = 3usize

Get the compile-time known size of this struct

Source

pub fn new(packet_id: u16, reason_code: u8) -> Self

Source

pub const fn supports_raw_pointer_encoding() -> bool

Check if this struct supports raw pointer encoding

Source

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

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.

Source

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

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.

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source§

impl AckPacketHeader

Source

pub fn create(packet_id: u16, reason_code: ReasonCode) -> Self

Creates a new acknowledgment packet header

Source

pub fn get_reason_code(&self) -> Option<ReasonCode>

Gets the reason code as a ReasonCode enum

Trait Implementations§

Source§

impl BeBytes for AckPacketHeader

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

fn field_size() -> usize

Source§

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

Try to parse a struct from big-endian bytes Read more
Source§

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

Source§

fn to_be_bytes_buf(&self) -> Bytes

Convert to big-endian bytes as a Bytes buffer Read more
Source§

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

Try to parse a struct from little-endian bytes Read more
Source§

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

Source§

fn to_le_bytes_buf(&self) -> Bytes

Convert to little-endian bytes as a Bytes buffer Read more
Source§

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

Encode directly to a buffer in big-endian format Read more
Source§

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

Encode directly to a buffer in little-endian format Read more
Source§

impl Clone for AckPacketHeader

Source§

fn clone(&self) -> AckPacketHeader

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 AckPacketHeader

Source§

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

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

impl PartialEq for AckPacketHeader

Source§

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

Source§

impl Eq for AckPacketHeader

Source§

impl StructuralPartialEq for AckPacketHeader

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more