mqtt-tiny 0.4.0

A tiny MQTT v3.1.1 codec implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

// Provides some type aliases that offer reasonable defaults for the underlying container types

/// Validates the feature combination
const _FEATURES_VALID: bool = match (cfg!(feature = "std"), cfg!(feature = "arrayvec"), cfg!(feature = "heapless")) {
    (true, false, false) | (false, true, false) | (false, false, true) => true,
    _ => panic!("you must not select more than one backing at a time (i.e. `std` or `arrayvec` or `heapless`)"),
};

/// The default byte container type used within top-level types
#[cfg(feature = "std")]
#[doc(hidden)]
pub type Bytes = std::vec::Vec<u8>;
/// The default byte container type used within top-level types
///
/// # Note
/// This default configuration allows for 256 bytes per byte field on the stack.
#[cfg(feature = "arrayvec")]
#[doc(hidden)]
pub type Bytes = arrayvec::ArrayVec<u8, 256>;
/// The default byte container type used within top-level types
///
/// # Note
/// This default configuration allows for 256 bytes per byte field on the stack.
#[cfg(feature = "heapless")]
#[doc(hidden)]
pub type Bytes = heapless::Vec<u8, 256>;

/// The default collection type for topic lists used within top-level types
#[cfg(feature = "std")]
#[doc(hidden)]
pub type Topics = std::vec::Vec<Bytes>;
/// The default collection type for topic lists used within top-level types
///
/// # Note
/// This default configuration allows for 4 topics per unsubscribe message.
#[cfg(feature = "arrayvec")]
#[doc(hidden)]
pub type Topics = arrayvec::ArrayVec<Bytes, 4>;
/// The default collection type for topic lists used within top-level types
///
/// # Note
/// This default configuration allows for 4 topics per unsubscribe message.
#[cfg(feature = "heapless")]
#[doc(hidden)]
pub type Topics = heapless::Vec<Bytes, 4>;

/// The default collection type for topic+quality-of-service lists used within top-level types
#[cfg(feature = "std")]
#[doc(hidden)]
pub type TopicsQos = std::vec::Vec<(Bytes, u8)>;
/// The default collection type for topic+quality-of-service lists used within top-level types
///
/// # Note
/// This default configuration allows for 4 topic+quality-of-service tuples per subscribe message.
#[cfg(feature = "arrayvec")]
#[doc(hidden)]
pub type TopicsQos = arrayvec::ArrayVec<(Bytes, u8), 4>;
/// The default collection type for topic+quality-of-service lists used within top-level types
///
/// # Note
/// This default configuration allows for 4 topic+quality-of-service tuples per subscribe message.
#[cfg(feature = "heapless")]
#[doc(hidden)]
pub type TopicsQos = heapless::Vec<(Bytes, u8), 4>;

/// A type-erased MQTT packet
pub type Packet = crate::packets::packet::Packet<Topics, TopicsQos, Bytes>;
/// An MQTT [`CONNACK` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718033)
pub type Connack = crate::packets::connack::Connack;
/// An MQTT [`CONNECT` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718033)
pub type Connect = crate::packets::connect::Connect<Bytes>;
/// An MQTT [`DISCONNECT` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718090)
pub type Disconnect = crate::packets::disconnect::Disconnect;
/// An MQTT [`PINGREQ` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718081)
pub type Pingreq = crate::packets::pingreq::Pingreq;
/// An MQTT [`PINGRESP` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718086)
pub type Pingresp = crate::packets::pingresp::Pingresp;
/// An MQTT [`PUBACK` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718043)
pub type Puback = crate::packets::puback::Puback;
/// An MQTT [`PUBCOMP` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718058)
pub type Pubcomp = crate::packets::pubcomp::Pubcomp;
/// An MQTT [`PUBLISH` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718037)
pub type Publish = crate::packets::publish::Publish<Bytes>;
/// An MQTT [`PUBREC` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718048)
pub type Pubrec = crate::packets::pubrec::Pubrec;
/// An MQTT [`PUBREL` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718053)
pub type Pubrel = crate::packets::pubrel::Pubrel;
/// An MQTT [`SUBACK` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718068)
pub type Suback = crate::packets::suback::Suback;
/// An MQTT [`SUBSCRIBE` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718063)
pub type Subscribe = crate::packets::subscribe::Subscribe<TopicsQos, Bytes>;
/// An MQTT [`UNSUBACK` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718077)
pub type Unsuback = crate::packets::unsuback::Unsuback;
/// An MQTT [`UNSUBSCRIBE` packet](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718072)
pub type Unsubscribe = crate::packets::unsubscribe::Unsubscribe<Topics, Bytes>;