Struct GenericStore

pub struct GenericStore<PacketIdType: IsPacketId> { /* private fields */ }

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. A store that holds packets in insertion order and allows O(1) insert/remove by id.

Implementations

impl<PacketIdType: IsPacketId> GenericStore<PacketIdType>

pub fn new() -> Self

Create a new empty store.

pub fn add( &mut self, packet: GenericStorePacket<PacketIdType>, ) -> Result<(), MqttError>

Add a packet to the store. Returns true if inserted, false if a packet with same id already exists.

pub fn erase( &mut self, response: ResponsePacket, packet_id: PacketIdType, ) -> bool

Erase a packet by its response type and packet id. Returns true if removed, false otherwise.

pub fn erase_publish(&mut self, packet_id: PacketIdType) -> bool

Erase a publish packet by packet id only. Returns true if removed, false otherwise.

pub fn clear(&mut self)

Clear all stored packets.

pub fn for_each<F>(&mut self, func: F)

where F: FnMut(&GenericStorePacket<PacketIdType>) -> bool,

Iterate over packets in insertion order. The provided function returns true to keep the packet, or false to remove it.

pub fn get_stored(&self) -> Vec<GenericStorePacket<PacketIdType>>

Return a vector of all stored packets in insertion order.