lfan 0.2.6

Generic Caching Library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

use std::borrow::Borrow;
use std::hash::Hash;

pub trait Cache {
    type Key: Hash + Eq + std::fmt::Debug;
    type Value;

    /// Insert an item in the cache.
    ///
    /// The first return value indicates whether an insertion has taken place (because the cache can refuse to insert an item).
    /// The second return value is the optional eviction victim, returned only if this call to insert caused an eviction.
    fn insert(&mut self, key: Self::Key, value: Self::Value) -> (bool, Option<Self::Value>);

    fn get<Q: ?Sized>(&mut self, key: &Q) -> Option<&Self::Value>
    where
        Self::Key: Borrow<Q>,
        Q: Hash + Eq;

    fn invalidate<Q: ?Sized>(&mut self, key: &Q)
    where
        Self::Key: Borrow<Q>,
        Q: Hash + Eq;

    fn clear(&mut self);
}