Struct TtlCache

pub struct TtlCache<K, T>
where
    K: Ord + Clone,
    T: Clone,
{ /* private fields */ }

A time-to-live cache that removes values when they expire. This is used to store and look up orders, to determine how old they are for rate limiting penalties when editing or cancelling.

Implementations

impl<K, T> TtlCache<K, T>

where K: Ord + Clone, T: Clone,

pub fn new() -> TtlCache<K, T>

Create a new, empty cache.

pub fn insert(&mut self, ttl_entry: TtlEntry<K, T>) -> Option<TtlEntry<K, T>>

Insert the provided TtlEntry by it’s id for future lookup. Entries beyond their ttl are removed automatically any time the remove, get, or contains methods are called.

pub fn remove(&mut self, ttl_entry: &TtlEntry<K, T>) -> bool

Removes an entry manually, returning if the entry was removed.

The cache is cleaned of any expired values after checking if this value was removed.

This follows the same semantics as BTreeSet’s remove method.

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

Returns if the provided key is in the cache, after removing any expired values.

pub fn get(&mut self, id: &K) -> Option<&TtlEntry<K, T>>

Gets a TtlEntry by id after removing any expired values.

Trait Implementations

impl<K, T> Debug for TtlCache<K, T>

where K: Ord + Clone + Debug, T: Clone + Debug,

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

Formats the value using the given formatter.

impl<K, T> Default for TtlCache<K, T>

where K: Ord + Clone, T: Clone,

fn default() -> Self

Returns the “default value” for a type.