mqtt_protocol_core/mqtt/packet/
enum_packet.rs

1// MIT License
2//
3// Copyright (c) 2025 Takatoshi Kondo
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to deal
7// in the Software without restriction, including without limitation the rights
8// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9// copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in all
13// copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21// SOFTWARE.
22use crate::mqtt::packet::v3_1_1;
23use crate::mqtt::packet::v5_0;
24use crate::mqtt::packet::IsPacketId;
25use crate::mqtt::packet::PacketType;
26use crate::mqtt::Version;
27use alloc::vec::Vec;
28use enum_dispatch::enum_dispatch;
29use serde::Serialize;
30#[cfg(feature = "std")]
31use std::io::IoSlice;
32
33#[enum_dispatch]
34pub trait GenericPacketTrait {
35    fn size(&self) -> usize;
36
37    /// Create a continuous buffer containing the complete packet data
38    ///
39    /// Returns a vector containing all packet bytes in a single continuous buffer.
40    /// This method is compatible with no-std environments.
41    ///
42    /// The returned buffer contains the complete packet serialized according
43    /// to the MQTT protocol specification.
44    ///
45    /// # Returns
46    ///
47    /// A vector containing the complete packet data
48    fn to_continuous_buffer(&self) -> Vec<u8>;
49
50    #[cfg(feature = "std")]
51    fn to_buffers(&self) -> Vec<IoSlice<'_>>;
52}
53
54#[enum_dispatch]
55pub trait GenericPacketDisplay {
56    fn fmt_debug(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result;
57    fn fmt_display(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result;
58}
59
60#[enum_dispatch(GenericPacketTrait, GenericPacketDisplay)]
61#[derive(Serialize, Clone, PartialEq, Eq)]
62pub enum GenericPacket<PacketIdType>
63where
64    PacketIdType: IsPacketId + Serialize,
65{
66    V3_1_1Connect(v3_1_1::Connect),
67    V3_1_1Connack(v3_1_1::Connack),
68    V3_1_1Subscribe(v3_1_1::GenericSubscribe<PacketIdType>),
69    V3_1_1Suback(v3_1_1::GenericSuback<PacketIdType>),
70    V3_1_1Unsubscribe(v3_1_1::GenericUnsubscribe<PacketIdType>),
71    V3_1_1Unsuback(v3_1_1::GenericUnsuback<PacketIdType>),
72    V3_1_1Publish(v3_1_1::GenericPublish<PacketIdType>),
73    V3_1_1Puback(v3_1_1::GenericPuback<PacketIdType>),
74    V3_1_1Pubrec(v3_1_1::GenericPubrec<PacketIdType>),
75    V3_1_1Pubrel(v3_1_1::GenericPubrel<PacketIdType>),
76    V3_1_1Pubcomp(v3_1_1::GenericPubcomp<PacketIdType>),
77    V3_1_1Disconnect(v3_1_1::Disconnect),
78    V3_1_1Pingreq(v3_1_1::Pingreq),
79    V3_1_1Pingresp(v3_1_1::Pingresp),
80
81    V5_0Connect(v5_0::Connect),
82    V5_0Connack(v5_0::Connack),
83    V5_0Subscribe(v5_0::GenericSubscribe<PacketIdType>),
84    V5_0Suback(v5_0::GenericSuback<PacketIdType>),
85    V5_0Unsubscribe(v5_0::GenericUnsubscribe<PacketIdType>),
86    V5_0Unsuback(v5_0::GenericUnsuback<PacketIdType>),
87    V5_0Publish(v5_0::GenericPublish<PacketIdType>),
88    V5_0Puback(v5_0::GenericPuback<PacketIdType>),
89    V5_0Pubrec(v5_0::GenericPubrec<PacketIdType>),
90    V5_0Pubrel(v5_0::GenericPubrel<PacketIdType>),
91    V5_0Pubcomp(v5_0::GenericPubcomp<PacketIdType>),
92    V5_0Disconnect(v5_0::Disconnect),
93    V5_0Pingreq(v5_0::Pingreq),
94    V5_0Pingresp(v5_0::Pingresp),
95    V5_0Auth(v5_0::Auth),
96}
97
98// Type alias for commonly used u16 PacketIdType
99pub type Packet = GenericPacket<u16>;
100
101impl<PacketIdType> core::fmt::Debug for GenericPacket<PacketIdType>
102where
103    PacketIdType: IsPacketId + Serialize,
104{
105    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
106        self.fmt_debug(f)
107    }
108}
109
110impl<PacketIdType> core::fmt::Display for GenericPacket<PacketIdType>
111where
112    PacketIdType: IsPacketId + Serialize,
113{
114    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
115        self.fmt_display(f)
116    }
117}
118
119impl<PacketIdType> GenericPacket<PacketIdType>
120where
121    PacketIdType: IsPacketId + Serialize,
122{
123    /// Get the packet type
124    pub fn packet_type(&self) -> PacketType {
125        match self {
126            GenericPacket::V3_1_1Connect(_) => PacketType::Connect,
127            GenericPacket::V3_1_1Connack(_) => PacketType::Connack,
128            GenericPacket::V3_1_1Subscribe(_) => PacketType::Subscribe,
129            GenericPacket::V3_1_1Suback(_) => PacketType::Suback,
130            GenericPacket::V3_1_1Unsubscribe(_) => PacketType::Unsubscribe,
131            GenericPacket::V3_1_1Unsuback(_) => PacketType::Unsuback,
132            GenericPacket::V3_1_1Publish(_) => PacketType::Publish,
133            GenericPacket::V3_1_1Puback(_) => PacketType::Puback,
134            GenericPacket::V3_1_1Pubrec(_) => PacketType::Pubrec,
135            GenericPacket::V3_1_1Pubrel(_) => PacketType::Pubrel,
136            GenericPacket::V3_1_1Pubcomp(_) => PacketType::Pubcomp,
137            GenericPacket::V3_1_1Disconnect(_) => PacketType::Disconnect,
138            GenericPacket::V3_1_1Pingreq(_) => PacketType::Pingreq,
139            GenericPacket::V3_1_1Pingresp(_) => PacketType::Pingresp,
140
141            GenericPacket::V5_0Connect(_) => PacketType::Connect,
142            GenericPacket::V5_0Connack(_) => PacketType::Connack,
143            GenericPacket::V5_0Subscribe(_) => PacketType::Subscribe,
144            GenericPacket::V5_0Suback(_) => PacketType::Suback,
145            GenericPacket::V5_0Unsubscribe(_) => PacketType::Unsubscribe,
146            GenericPacket::V5_0Unsuback(_) => PacketType::Unsuback,
147            GenericPacket::V5_0Publish(_) => PacketType::Publish,
148            GenericPacket::V5_0Puback(_) => PacketType::Puback,
149            GenericPacket::V5_0Pubrec(_) => PacketType::Pubrec,
150            GenericPacket::V5_0Pubrel(_) => PacketType::Pubrel,
151            GenericPacket::V5_0Pubcomp(_) => PacketType::Pubcomp,
152            GenericPacket::V5_0Disconnect(_) => PacketType::Disconnect,
153            GenericPacket::V5_0Pingreq(_) => PacketType::Pingreq,
154            GenericPacket::V5_0Pingresp(_) => PacketType::Pingresp,
155            GenericPacket::V5_0Auth(_) => PacketType::Auth,
156        }
157    }
158
159    /// Get the MQTT protocol version of this packet
160    pub fn protocol_version(&self) -> Version {
161        match self {
162            GenericPacket::V3_1_1Connect(_) => Version::V3_1_1,
163            GenericPacket::V3_1_1Connack(_) => Version::V3_1_1,
164            GenericPacket::V3_1_1Subscribe(_) => Version::V3_1_1,
165            GenericPacket::V3_1_1Suback(_) => Version::V3_1_1,
166            GenericPacket::V3_1_1Unsubscribe(_) => Version::V3_1_1,
167            GenericPacket::V3_1_1Unsuback(_) => Version::V3_1_1,
168            GenericPacket::V3_1_1Publish(_) => Version::V3_1_1,
169            GenericPacket::V3_1_1Puback(_) => Version::V3_1_1,
170            GenericPacket::V3_1_1Pubrec(_) => Version::V3_1_1,
171            GenericPacket::V3_1_1Pubrel(_) => Version::V3_1_1,
172            GenericPacket::V3_1_1Pubcomp(_) => Version::V3_1_1,
173            GenericPacket::V3_1_1Disconnect(_) => Version::V3_1_1,
174            GenericPacket::V3_1_1Pingreq(_) => Version::V3_1_1,
175            GenericPacket::V3_1_1Pingresp(_) => Version::V3_1_1,
176
177            GenericPacket::V5_0Connect(_) => Version::V5_0,
178            GenericPacket::V5_0Connack(_) => Version::V5_0,
179            GenericPacket::V5_0Subscribe(_) => Version::V5_0,
180            GenericPacket::V5_0Suback(_) => Version::V5_0,
181            GenericPacket::V5_0Unsubscribe(_) => Version::V5_0,
182            GenericPacket::V5_0Unsuback(_) => Version::V5_0,
183            GenericPacket::V5_0Publish(_) => Version::V5_0,
184            GenericPacket::V5_0Puback(_) => Version::V5_0,
185            GenericPacket::V5_0Pubrec(_) => Version::V5_0,
186            GenericPacket::V5_0Pubrel(_) => Version::V5_0,
187            GenericPacket::V5_0Pubcomp(_) => Version::V5_0,
188            GenericPacket::V5_0Disconnect(_) => Version::V5_0,
189            GenericPacket::V5_0Pingreq(_) => Version::V5_0,
190            GenericPacket::V5_0Pingresp(_) => Version::V5_0,
191            GenericPacket::V5_0Auth(_) => Version::V5_0,
192        }
193    }
194}
mqtt_protocol_core/mqtt/packet/enum_packet.rs

mqtt_protocol_core/mqtt/packet/
enum_packet.rs
