mqtt-protocol-core 0.7.7

A Sans-I/O style MQTT protocol library for Rust that supports both MQTT v5.0 and v3.1.1.
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

// 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.

mod arc;
pub use arc::Arc;

mod arc_payload;
pub use arc_payload::{ArcPayload, IntoPayload};

mod value_allocator;
pub use value_allocator::ValueAllocator;

mod cursor;
pub use cursor::Cursor;
pub use cursor::CursorError;

pub(crate) mod tracing;

/// Type alias for HashSet to provide a stable API abstraction over the underlying hash set implementation.
///
/// This alias allows the library to use a high-performance hash set implementation
/// (currently hashbrown::HashSet) while providing API stability to users. It also
/// ensures consistent usage across the entire codebase.
///
/// # Examples
///
/// ```ignore
/// use mqtt_protocol_core::mqtt::common::HashSet;
///
/// let mut set = HashSet::default();
/// set.insert("key");
/// ```
pub type HashSet<T> = hashbrown::HashSet<T, foldhash::fast::RandomState>;

/// Type alias for HashMap to provide a stable API abstraction over the underlying hash map implementation.
///
/// This alias allows the library to use a high-performance hash map implementation
/// (currently hashbrown::HashMap) while providing API stability to users. It also
/// ensures consistent usage across the entire codebase.
///
/// # Examples
///
/// ```ignore
/// use mqtt_protocol_core::mqtt::common::HashMap;
///
/// let mut map = HashMap::default();
/// map.insert("key", "value");
/// ```
pub type HashMap<K, V> = hashbrown::HashMap<K, V, foldhash::fast::RandomState>;

/// Type alias for IndexMap to provide a stable API abstraction over the underlying hash map implementation.
///
/// This alias allows the library to use a high-performance hash map implementation
/// (currently indexmap::IndexMap) while providing API stability to users. It also
/// ensures consistent usage across the entire codebase.
///
/// # Examples
///
/// ```ignore
/// use mqtt_protocol_core::mqtt::common::IndexMap;
///
/// let mut map = IndexMap::default();
/// map.insert("key", "value");
/// ```
pub type IndexMap<K, V> = indexmap::IndexMap<K, V, foldhash::fast::RandomState>;