Struct DynamicSeenCache 

pub struct DynamicSeenCache { /* private fields */ }

A duplicate cache whose size is chosen when it is built, rather than at compile time.

SeenCache fixes its capacity in the type, which suits a microcontroller that knows its own limits. A gateway, or any caller reaching this through a language binding, does not know the size until it runs, and a const generic cannot cross a foreign function boundary at all. This is the same cache with its slots on the heap, so both share one implementation and answer identically.

Requires the alloc feature.

Examples

use pamoja_mesh::DynamicSeenCache;

// A busy relay remembers more packets than a leaf node needs to.
let mut seen = DynamicSeenCache::new(1024);
assert!(seen.record((0x42, 1)));
assert!(!seen.record((0x42, 1)));
assert_eq!(seen.capacity(), 1024);

Implementations

impl DynamicSeenCache

pub fn new(capacity: usize) -> Self

Creates an empty cache remembering up to capacity packets.

Arguments

• capacity - how many recently seen packets to remember. A capacity of zero is allowed and makes every packet read as new, which relays every copy.

Returns

A cache holding no keys.

pub fn capacity(&self) -> usize

Returns how many packets this cache remembers.

Returns

The capacity it was created with.

pub fn contains(&self, key: (u32, u16)) -> bool

Reports whether a key is currently remembered.

Arguments

• key - the packet key to look for, from dedup_key.

Returns

true if the key is in the cache.

pub fn record(&mut self, key: (u32, u16)) -> bool

Records a key, reporting whether it was new.

Arguments

• key - the packet key to record, from dedup_key.

Returns

true if the packet is new, false if it is a duplicate.

Trait Implementations

impl Clone for DynamicSeenCache

fn clone(&self) -> DynamicSeenCache

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DynamicSeenCache

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.