mqtt_protocol_core/mqtt/common/
mod.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.
22
23mod arc;
24pub use arc::Arc;
25
26mod arc_payload;
27pub use arc_payload::{ArcPayload, IntoPayload};
28
29mod value_allocator;
30pub use value_allocator::ValueAllocator;
31
32mod cursor;
33pub use cursor::Cursor;
34pub use cursor::CursorError;
35
36pub(crate) mod tracing;
37
38/// Type alias for HashSet to provide a stable API abstraction over the underlying hash set implementation.
39///
40/// This alias allows the library to use a high-performance hash set implementation
41/// (currently hashbrown::HashSet) while providing API stability to users. It also
42/// ensures consistent usage across the entire codebase.
43///
44/// # Examples
45///
46/// ```ignore
47/// use mqtt_protocol_core::mqtt::common::HashSet;
48///
49/// let mut set = HashSet::default();
50/// set.insert("key");
51/// ```
52pub type HashSet<T> = hashbrown::HashSet<T, foldhash::fast::RandomState>;
53
54/// Type alias for HashMap to provide a stable API abstraction over the underlying hash map implementation.
55///
56/// This alias allows the library to use a high-performance hash map implementation
57/// (currently hashbrown::HashMap) while providing API stability to users. It also
58/// ensures consistent usage across the entire codebase.
59///
60/// # Examples
61///
62/// ```ignore
63/// use mqtt_protocol_core::mqtt::common::HashMap;
64///
65/// let mut map = HashMap::default();
66/// map.insert("key", "value");
67/// ```
68pub type HashMap<K, V> = hashbrown::HashMap<K, V, foldhash::fast::RandomState>;
69
70/// Type alias for IndexMap to provide a stable API abstraction over the underlying hash map implementation.
71///
72/// This alias allows the library to use a high-performance hash map implementation
73/// (currently indexmap::IndexMap) while providing API stability to users. It also
74/// ensures consistent usage across the entire codebase.
75///
76/// # Examples
77///
78/// ```ignore
79/// use mqtt_protocol_core::mqtt::common::IndexMap;
80///
81/// let mut map = IndexMap::default();
82/// map.insert("key", "value");
83/// ```
84pub type IndexMap<K, V> = indexmap::IndexMap<K, V, foldhash::fast::RandomState>;
mqtt_protocol_core/mqtt/common/mod.rs

mqtt_protocol_core/mqtt/common/
mod.rs
