Struct TimedMap

pub struct TimedMap<C, K, V>
where
    C: Clock,
    K: Eq + Copy,
{ /* private fields */ }

Associates keys of type K with values of type V. Each entry may optionally expire after a specified duration.

Mutable functions automatically clears expired entries when called.

If no expiration is set, the entry remains constant.

Implementations

impl<C: Clock, K: Copy + Eq + Ord, V> TimedMap<C, K, V>

pub fn new() -> Self

Creates an empty map.

pub fn get(&self, k: &K) -> Option<&V>

Returns the associated value if present and not expired.

pub fn get_remaining_duration(&self, k: &K) -> Option<Duration>

Returns the associated value’s Duration if present and not expired.

Returns None if the entry does not exist or is constant.

pub fn insert_expirable(&mut self, k: K, v: V, duration: Duration) -> Option<V>

Inserts a key-value pair with an expiration duration.

If a value already exists for the given key, it will be updated and then the old one will be returned.

pub fn insert_constant(&mut self, k: K, v: V) -> Option<V>

Inserts a key-value pair with that doesn’t expire.

If a value already exists for the given key, it will be updated and then the old one will be returned.

pub fn remove(&mut self, k: &K) -> Option<V>

Removes a key-value pair from the map and returns the associated value if present and not expired.

Trait Implementations

impl<C: Clock, K: Copy + Eq + Ord, V> Default for TimedMap<C, K, V>

fn default() -> Self

Returns the “default value” for a type.