fast-lru 0.1.2

A fast, 100% safe, stack based LRU 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
31
32
33
34
35
36
37
38
39
40
41

# fast-lru


A fast, 100% safe, stack based least recently used cache. 

fast-lru uses a stack based array to store all the values, in conjunction 
with a hashmap to store the keys. It gaurentees `O(1)` time complexity 
for all operations, including `get()`, `put()`, `get_mut()`, and `pop()`.


## Example 


This a simple example of creating a cache, adding some values, and then reading them.

```rust,no_run
use lru::LruCache

fn main() {
    let mut cache: LruCache<_, _, 2> = LruCache::new();

    cache.put("cow", 3);
    cache.put("pig", 2);

    assert_eq!(*cache.get(&"cow").unwrap(), 3);
    assert_eq!(*cache.get(&"pig").unwrap(), 2);
    assert!(cache.get(&"dog").is_none());

    assert_eq!(cache.put("pig", 4), Some(2));
    assert_eq!(cache.put("dog", 5), None);

    assert_eq!(*cache.get(&"dog").unwrap(), 5);
    assert_eq!(*cache.get(&"pig").unwrap(), 4);
    assert!(cache.get(&"cow").is_none());

    {
        let v = cache.get_mut(&"pig").unwrap();
        *v = 6;
    }

    assert_eq!(*cache.get(&"pig").unwrap(), 6);
}
```