caches 0.3.0

This is a Rust implementation for popular caches (support no_std).
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use caches::{Cache, PutResult, WTinyLFUCache};

fn main() {
    let mut cache = WTinyLFUCache::with_sizes(1, 2, 2, 5).unwrap();
    assert_eq!(cache.cap(), 5);
    assert_eq!(cache.window_cache_cap(), 1);
    assert_eq!(cache.main_cache_cap(), 4);

    assert_eq!(cache.put(1, 1), PutResult::Put);
    assert!(cache.contains(&1));
    assert_eq!(cache.put(2, 2), PutResult::Put);
    assert!(cache.contains(&2));
    assert_eq!(cache.put(3, 3), PutResult::Put);
    assert!(cache.contains(&3));

    // current state
    // window cache:        (MRU) [3] (LRU)
    // probationary cache:  (MRU) [2, 1] (LRU)
    // protected cache:     (MRU) [] (LRU)
    assert_eq!(cache.window_cache_len(), 1);
    assert_eq!(cache.main_cache_len(), 2);

    assert_eq!(cache.put(2, 22), PutResult::Update(2));
    assert_eq!(cache.put(1, 11), PutResult::Update(1));

    // current state
    // window cache:        (MRU) [3] (LRU)
    // probationary cache:  (MRU) [] (LRU)
    // protected cache:     (MRU) [1, 2] (LRU)
    assert_eq!(cache.window_cache_len(), 1);

    assert_eq!(cache.put(3, 33), PutResult::Update(3));

    // current state
    // window cache:        (MRU) [2] (LRU)
    // probationary cache:  (MRU) [] (LRU)
    // protected cache:     (MRU) [3, 1] (LRU)
    assert_eq!(cache.window_cache_len(), 1);

    assert_eq!(cache.put(4, 4), PutResult::Put);
    assert_eq!(cache.put(5, 5), PutResult::Put);

    // current state
    // window cache:        (MRU) [5] (LRU)
    // probationary cache:  (MRU) [4, 2] (LRU)
    // protected cache:     (MRU) [3, 1] (LRU)

    assert_eq!(cache.get(&4), Some(&4));
    assert_eq!(cache.get_mut(&5), Some(&mut 5));

    // current state
    // window cache:        (MRU) [5] (LRU)
    // probationary cache:  (MRU) [1, 2] (LRU)
    // protected cache:     (MRU) [4, 3] (LRU)
    assert_eq!(cache.peek(&3), Some(&33));
    assert_eq!(cache.peek_mut(&2), Some(&mut 22));

    assert_eq!(cache.remove(&3), Some(33));
    assert_eq!(cache.remove(&2), Some(22));
}