Trait PacketKind

pub trait PacketKind {
    const IS_CONNECT: bool = false;
    const IS_CONNACK: bool = false;
    const IS_PUBLISH: bool = false;
    const IS_PUBACK: bool = false;
    const IS_PUBREC: bool = false;
    const IS_PUBREL: bool = false;
    const IS_PUBCOMP: bool = false;
    const IS_SUBSCRIBE: bool = false;
    const IS_SUBACK: bool = false;
    const IS_UNSUBSCRIBE: bool = false;
    const IS_UNSUBACK: bool = false;
    const IS_PINGREQ: bool = false;
    const IS_PINGRESP: bool = false;
    const IS_DISCONNECT: bool = false;
    const IS_AUTH: bool = false;
    const IS_V3_1_1: bool = false;
    const IS_V5_0: bool = false;
}

MIT License

Copyright (c) 2025 Takatoshi Kondo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Trait for compile-time packet classification and type introspection

PacketKind provides a way to classify MQTT packet types at compile time using constant boolean flags. This enables efficient type-based dispatch and filtering without runtime overhead. Each MQTT packet type implements this trait with appropriate flags set to true.

The trait includes flags for:

• Packet types: CONNECT, CONNACK, PUBLISH, PUBACK, PUBREC, PUBREL, PUBCOMP, SUBSCRIBE, SUBACK, UNSUBSCRIBE, UNSUBACK, PINGREQ, PINGRESP, DISCONNECT, AUTH
• Protocol versions: V3_1_1, V5_0

Examples

use mqtt_protocol_core::mqtt::packet::PacketKind;
use mqtt_protocol_core::mqtt::packet::v5_0::Connect;

// Check packet type at compile time
if Connect::IS_CONNECT {
    println!("This is a CONNECT packet");
}

// Check protocol version
if Connect::IS_V5_0 {
    println!("This is a v5.0 packet");
}

Provided Associated Constants

const IS_CONNECT: bool = false

true if this is a CONNECT packet

const IS_CONNACK: bool = false

true if this is a CONNACK packet

const IS_PUBLISH: bool = false

true if this is a PUBLISH packet

const IS_PUBACK: bool = false

true if this is a PUBACK packet

const IS_PUBREC: bool = false

true if this is a PUBREC packet

const IS_PUBREL: bool = false

true if this is a PUBREL packet

const IS_PUBCOMP: bool = false

true if this is a PUBCOMP packet

const IS_SUBSCRIBE: bool = false

true if this is a SUBSCRIBE packet

const IS_SUBACK: bool = false

true if this is a SUBACK packet

const IS_UNSUBSCRIBE: bool = false

true if this is an UNSUBSCRIBE packet

const IS_UNSUBACK: bool = false

true if this is an UNSUBACK packet

const IS_PINGREQ: bool = false

true if this is a PINGREQ packet

const IS_PINGRESP: bool = false

true if this is a PINGRESP packet

const IS_DISCONNECT: bool = false

true if this is a DISCONNECT packet

const IS_AUTH: bool = false

true if this is an AUTH packet (v5.0 only)

const IS_V3_1_1: bool = false

true if this is an MQTT v3.1.1 packet

const IS_V5_0: bool = false

true if this is an MQTT v5.0 packet

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: PacketKind> PacketKind for &T

PacketKind implementation for references to packet types

This implementation forwards all flags from the referenced type, allowing packet references to be used with the same type checking.

const IS_CONNECT: bool = T::IS_CONNECT

const IS_CONNACK: bool = T::IS_CONNACK

const IS_PUBLISH: bool = T::IS_PUBLISH

const IS_PUBACK: bool = T::IS_PUBACK

const IS_PUBREC: bool = T::IS_PUBREC

const IS_PUBREL: bool = T::IS_PUBREL

const IS_PUBCOMP: bool = T::IS_PUBCOMP

const IS_SUBSCRIBE: bool = T::IS_SUBSCRIBE

const IS_SUBACK: bool = T::IS_SUBACK

const IS_UNSUBSCRIBE: bool = T::IS_UNSUBSCRIBE

const IS_UNSUBACK: bool = T::IS_UNSUBACK

const IS_PINGREQ: bool = T::IS_PINGREQ

const IS_PINGRESP: bool = T::IS_PINGRESP

const IS_DISCONNECT: bool = T::IS_DISCONNECT

const IS_AUTH: bool = T::IS_AUTH

const IS_V3_1_1: bool = T::IS_V3_1_1

const IS_V5_0: bool = T::IS_V5_0

Implementors

impl PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::Connack

PacketKind implementation for v3.1.1 CONNACK packet

const IS_CONNACK: bool = true

const IS_V3_1_1: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::Connect

PacketKind implementation for v3.1.1 CONNECT packet

const IS_CONNECT: bool = true

const IS_V3_1_1: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::Disconnect

PacketKind implementation for v3.1.1 DISCONNECT packet

const IS_DISCONNECT: bool = true

const IS_V3_1_1: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::Pingreq

PacketKind implementation for v3.1.1 PINGREQ packet

const IS_PINGREQ: bool = true

const IS_V3_1_1: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::Pingresp

PacketKind implementation for v3.1.1 PINGRESP packet

const IS_PINGRESP: bool = true

const IS_V3_1_1: bool = true

impl PacketKind for Auth

PacketKind implementation for v5.0 AUTH packet (v5.0 exclusive)

const IS_AUTH: bool = true

const IS_V5_0: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::Connack

PacketKind implementation for v5.0 CONNACK packet

const IS_CONNACK: bool = true

const IS_V5_0: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::Connect

PacketKind implementation for v5.0 CONNECT packet

const IS_CONNECT: bool = true

const IS_V5_0: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::Disconnect

const IS_DISCONNECT: bool = true

const IS_V5_0: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::Pingreq

PacketKind implementation for v5.0 PINGREQ packet

const IS_PINGREQ: bool = true

const IS_V5_0: bool = true

impl PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::Pingresp

const IS_PINGRESP: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for GenericPacket<PacketIdType>

where PacketIdType: IsPacketId + Serialize,

PacketKind implementation for GenericPacket enum

For enum types, all flags are false at compile time since the actual packet type is determined at runtime. This implementation provides a fallback for generic packet handling where compile-time type information is not available.

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericPuback<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBACK: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericPubcomp<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBCOMP: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericPublish<PacketIdType>

where PacketIdType: IsPacketId + 'static,

PacketKind implementation for generic v3.1.1 PUBLISH packet

const IS_PUBLISH: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericPubrec<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBREC: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericPubrel<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBREL: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericSuback<PacketIdType>

where PacketIdType: IsPacketId,

const IS_SUBACK: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericSubscribe<PacketIdType>

where PacketIdType: IsPacketId,

const IS_SUBSCRIBE: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericUnsuback<PacketIdType>

where PacketIdType: IsPacketId,

const IS_UNSUBACK: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v3_1_1::GenericUnsubscribe<PacketIdType>

where PacketIdType: IsPacketId,

const IS_UNSUBSCRIBE: bool = true

const IS_V3_1_1: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericPuback<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBACK: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericPubcomp<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBCOMP: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericPublish<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBLISH: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericPubrec<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBREC: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericPubrel<PacketIdType>

where PacketIdType: IsPacketId,

const IS_PUBREL: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericSuback<PacketIdType>

where PacketIdType: IsPacketId,

const IS_SUBACK: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericSubscribe<PacketIdType>

where PacketIdType: IsPacketId,

const IS_SUBSCRIBE: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericUnsuback<PacketIdType>

where PacketIdType: IsPacketId,

const IS_UNSUBACK: bool = true

const IS_V5_0: bool = true

impl<PacketIdType> PacketKind for mqtt_protocol_core::mqtt::packet::v5_0::GenericUnsubscribe<PacketIdType>

where PacketIdType: IsPacketId,

const IS_UNSUBSCRIBE: bool = true

const IS_V5_0: bool = true