Enum Packet

pub enum Packet {
    Connect(Connect),
    ConnAck(ConnAck),
    Publish(Publish),
    PubAck(PubAck),
    PubRec(PubRec),
    PubRel(PubRel),
    PubComp(PubComp),
    Subscribe(Subscribe),
    SubAck(SubAck),
    Unsubscribe(Unsubscribe),
    UnsubAck(UnsubAck),
    PingReq(PingReq),
    PingResp(PingResp),
    Disconnect(Disconnect),
    Auth(Auth),
}

Represents all possible MQTT v5 packet types

This enum serves as the main abstraction for working with MQTT packets, providing a unified interface for packet handling while maintaining type safety for each specific packet type.

Example

use std::time::Duration;
use mqute_codec::protocol::v5::Packet;
use mqute_codec::protocol::v5::{Connect, ConnectProperties};
use bytes::{Bytes, BytesMut};

let properties = ConnectProperties {
    session_expiry_interval: Some(3600),
    ..Default::default()
};

let connect = Connect::with_properties(
    "client",
    None,
    None,
    properties.clone(),
    Duration::from_secs(30),
    true);

let mut buf = BytesMut::new();

let packet = Packet::Connect(connect);

packet.encode(&mut buf).unwrap()

Variants

Connect(Connect)

Client-initiated connection request. First packet in connection establishment flow

ConnAck(ConnAck)

Server connection acknowledgment. Sent in response to CONNECT packet

Publish(Publish)

Message publication. Primary message delivery mechanism.

PubAck(PubAck)

QoS 1 publication acknowledgment. Acknowledges receipt of QoS 1 messages

PubRec(PubRec)

QoS 2 publication received (part 1). First packet in QoS 2 protocol flow

PubRel(PubRel)

QoS 2 publication release (part 2). Second packet in QoS 2 protocol flow

PubComp(PubComp)

QoS 2 publication complete (part 3). Final packet in QoS 2 protocol flow

Subscribe(Subscribe)

Subscription request. Begins subscription creation/modification

SubAck(SubAck)

Subscription acknowledgment. Confirms subscription processing results

Unsubscribe(Unsubscribe)

Unsubscription request. Begins subscription termination

UnsubAck(UnsubAck)

Unsubscription acknowledgment. Confirms unsubscription processing

PingReq(PingReq)

Keep-alive ping request. Must be responded to with PINGRESP

PingResp(PingResp)

Keep-alive ping response. Sent in response to PINGREQ to confirm connection is active

Disconnect(Disconnect)

Graceful connection termination. Properly closes the MQTT connection

Auth(Auth)

Authentication exchange. Used for extended authentication flows

Implementations

impl Packet

pub fn decode(raw_packet: RawPacket) -> Result<Self, Error>

Decodes a raw MQTT packet into the appropriate Packet variant

This is the primary entry point for packet processing, handling:

• Packet type identification
• Payload validation
• Special cases for empty payload packets
• Delegation to specific packet decoders

pub fn encode(&self, buf: &mut BytesMut) -> Result<(), Error>

Encodes the packet into its wire format

Delegates to the specific packet implementation’s encoder while providing a unified interface for all packet types.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl PartialEq for Packet

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

impl StructuralPartialEq for Packet