Enum FixedHeader

#[repr(u8)]
pub enum FixedHeader {
    Connect = 16,
    Connack = 32,
    Publish = 48,
    Puback = 64,
    Pubrec = 80,
    Pubrel = 98,
    Pubcomp = 112,
    Subscribe = 130,
    Suback = 144,
    Unsubscribe = 162,
    Unsuback = 176,
    Pingreq = 192,
    Pingresp = 208,
    Disconnect = 224,
    Auth = 240,
}

MQTT Fixed Header first byte enumeration

Represents the complete first byte of the MQTT Fixed Header, which includes both the packet type (bits 7-4) and packet-specific flags (bits 3-0). Each variant contains the full byte value with appropriate flags/reserved bits set.

Packet-Specific Flags

• PUBLISH: Contains DUP, QoS, and RETAIN flags (bits 3-0)
• PUBREL, SUBSCRIBE, UNSUBSCRIBE: Have reserved bits set as required by spec
• Other packets: Flags/reserved bits are typically zero

Examples

use mqtt_protocol_core::mqtt::packet::FixedHeader;

let header = FixedHeader::Connect;
assert_eq!(header.as_u8(), 0x10);
assert_eq!(header.packet_type(), PacketType::Connect);

Variants

Connect = 16

CONNECT packet header (0x10)

Connack = 32

CONNACK packet header (0x20)

Publish = 48

PUBLISH packet header (0x30) - flags for DUP, QoS, RETAIN in lower bits

Puback = 64

PUBACK packet header (0x40)

Pubrec = 80

PUBREC packet header (0x50)

Pubrel = 98

PUBREL packet header (0x62) - reserved bits set as required

Pubcomp = 112

PUBCOMP packet header (0x70)

Subscribe = 130

SUBSCRIBE packet header (0x82) - reserved bits set as required

Suback = 144

SUBACK packet header (0x90)

Unsubscribe = 162

UNSUBSCRIBE packet header (0xa2) - reserved bits set as required

Unsuback = 176

UNSUBACK packet header (0xb0)

Pingreq = 192

PINGREQ packet header (0xc0)

Pingresp = 208

PINGRESP packet header (0xd0)

Disconnect = 224

DISCONNECT packet header (0xe0)

Auth = 240

AUTH packet header (0xf0) - MQTT v5.0 only

Implementations

impl FixedHeader

pub fn as_u8(self) -> u8

Convert the fixed header to its byte value

Returns the complete first byte of the MQTT Fixed Header, including both packet type and flags/reserved bits.

Returns

The fixed header byte value

pub fn packet_type(self) -> PacketType

Extract the packet type from the fixed header

Extracts the packet type from bits 7-4 of the fixed header byte, discarding the flags/reserved bits in the lower 4 bits.

Returns

The PacketType extracted from the header, or PacketType::Connect as fallback

pub fn as_str(&self) -> &'static str

Convert the fixed header to its string representation

Returns the string representation of the underlying packet type. This is equivalent to calling self.packet_type().as_str().

Returns

A static string slice with the packet type name

Trait Implementations

impl Clone for FixedHeader

fn clone(&self) -> FixedHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FixedHeader

Debug FixedHeader using Display implementation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FixedHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FixedHeader

Display FixedHeader as JSON string

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

Formats the value using the given formatter.

impl PartialEq for FixedHeader

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

Serialize FixedHeader as a string

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u8> for FixedHeader

type Error = TryFromPrimitiveError<FixedHeader>

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for FixedHeader

const NAME: &'static str = "FixedHeader"

type Primitive = u8

type Error = TryFromPrimitiveError<FixedHeader>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for FixedHeader

impl Eq for FixedHeader

impl StructuralPartialEq for FixedHeader