cache_browns 0.0.1-poc.0

A general-purpose programmable, declarative cache
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
26
27
28
29
30

pub mod discrete_files;
pub mod memory;
pub mod replacement;

pub type KeyIterator<'a, Key> = Box<dyn Iterator<Item = Key> + 'a>;

pub trait CacheStoreStrategy<Key, Value> {
    fn get(&self, key: &Key) -> Option<Value>;

    /// A platform read of a value. When replacement strategies are used (e.g. LRU) reads have side
    /// effects that update internal tracking. If hydration requires inspecting the current state,
    /// these reads will skew tracking. Peek allows you to inspect state without side effects, it
    /// signals to any layer that a platform read has occurred that should be ignored for usage
    /// tracking purposes.
    ///
    /// For leaf nodes, you implement this as a call to [`CacheStoreStrategy::get`], however no default is offered to
    /// ensure the implementor has thought through whether or not they have side effects.
    fn peek(&self, key: &Key) -> Option<Value>;

    fn put(&mut self, key: &Key, value: Value);

    // TODO: not sure if the bool is necessary, forget why it's there off hand
    fn delete(&mut self, key: &Key) -> bool;

    fn flush(&mut self);

    fn get_keys(&self) -> KeyIterator<Key>;

    fn contains(&self, key: &Key) -> bool;
}