mqtt_protocol_core/mqtt/common/
mod.rs

1/**
2 * MIT License
3 *
4 * Copyright (c) 2025 Takatoshi Kondo
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24mod arc_payload;
25pub use arc_payload::{ArcPayload, IntoPayload};
26
27mod value_allocator;
28pub use value_allocator::ValueAllocator;
29
30mod cursor;
31pub use cursor::Cursor;
32pub use cursor::CursorError;
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::new();
46/// set.insert("key");
47/// ```
48pub type HashSet<T> = hashbrown::HashSet<T>;
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::new();
62/// map.insert("key", "value");
63/// ```
64pub type HashMap<K, V> = hashbrown::HashMap<K, V>;
mqtt_protocol_core/mqtt/common/mod.rs

mqtt_protocol_core/mqtt/common/
mod.rs
