Struct lru_time_cache::LruCache

pub struct LruCache<Key, Value> { /* fields omitted */ }

Implementation of LRU cache.

Methods

impl<Key, Value> LruCache<Key, Value> where
    Key: Ord + Clone, 

fn with_capacity(capacity: usize) -> LruCache<Key, Value>

Constructor for capacity based LruCache.

fn with_expiry_duration(time_to_live: Duration) -> LruCache<Key, Value>

Constructor for time based LruCache.

fn with_expiry_duration_and_capacity(
    time_to_live: Duration,
    capacity: usize
) -> LruCache<Key, Value>

Constructor for dual-feature capacity and time based LruCache.

fn insert(&mut self, key: Key, value: Value) -> Option<Value>

Inserts a key-value pair into the cache.

If the key already existed in the cache, the existing value is returned and overwritten in the cache. Otherwise, the key-value pair is inserted and None is returned.

fn remove<Q: ?Sized>(&mut self, key: &Q) -> Option<Value> where
    Key: Borrow<Q>,
    Q: Ord, 

Removes a key-value pair from the cache.

fn clear(&mut self)

Clears the LruCache, removing all values.

fn get<Q: ?Sized>(&mut self, key: &Q) -> Option<&Value> where
    Key: Borrow<Q>,
    Q: Ord, 

Retrieves a reference to the value stored under key, or None if the key doesn't exist. Also removes expired elements and updates the time.

fn peek<Q: ?Sized>(&self, key: &Q) -> Option<&Value> where
    Key: Borrow<Q>,
    Q: Ord, 

Returns a reference to the value with the given key, if present and not expired, without updating the timestamp.

fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut Value> where
    Key: Borrow<Q>,
    Q: Ord, 

Retrieves a mutable reference to the value stored under key, or None if the key doesn't exist. Also removes expired elements and updates the time.

fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool where
    Key: Borrow<Q>,
    Q: Ord, 

Returns whether key exists in the cache or not.

fn len(&self) -> usize

Returns the size of the cache, i.e. the number of cached non-expired key-value pairs.

fn is_empty(&self) -> bool

Returns true if there are no non-expired entries in the cache.

fn entry(&mut self, key: Key) -> Entry<Key, Value>

Gets the given key's corresponding entry in the map for in-place manipulation.

fn iter(&mut self) -> Iter<Key, Value>

Returns an iterator over all entries that updates the timestamps as values are traversed. Also removes expired elements before creating the iterator.

fn peek_iter(&self) -> PeekIter<Key, Value>

Returns an iterator over all entries that does not modify the timestamps.

Trait Implementations

impl<Key, Value> Clone for LruCache<Key, Value> where
    Key: Clone,
    Value: Clone, 

fn clone(&self) -> LruCache<Key, Value>

Returns a copy of the value.

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

Performs copy-assignment from source.