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