Struct Cache 

pub struct Cache<K, V> { /* private fields */ }

Cache of messages that we have already seen.

This is used to avoid sending the same message multiple times.

Implementations

impl<K, V> Cache<K, V>

pub fn with_capacity_and_ttl(capacity: usize, ttl: Duration) -> Self

Creates a new empty cache with the given capacity and time-to-live.

impl<K, V> Cache<K, V>

where K: Eq + Hash + Clone,

pub fn put(&mut self, id: K, message: V) -> bool

Inserts a message in the cache.

Returns true if the message was not already in the cache. Returns false if the message was already in the cache.

If the source is None, then the message is assumed to have been sent by us.

pub fn len(&self) -> usize

Returns the number of non-expired messages in the cache.

pub fn is_empty(&self) -> bool

Returns if the cache is empty.

pub fn contains_key(&self, id: &K) -> bool

Returns true if the cache contains a non-expired message with the given ID.

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

Returns a reference to the message with the given ID, if it exists in the cache and has not expired.

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

Removes the message with the given ID from the cache.

Returns the removed cache entry, if it existed in the cache and had not expired.

pub fn clear_expired_entries(&mut self)

Remove all expired messages from the cache.

An entry is considered expired if the elapsed time since the insertion of the entry is greater than the time-to-live of the cache, then the entry is considered expired.

Trait Implementations

impl<K, V> Default for Cache<K, V>

fn default() -> Self

Creates a new empty cache.

Capacity defaults to 1024 messages and a time-to-live to 5 seconds.