tiny-cache 0.5.0

FIFO and per-user LRU caches with shared values
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

# tiny-cache

Avoid doing the same work again when you already have the result. Save results for later, with a limit on how much you keep.

- **`FifoCache`** keeps a chosen number of results, removing the oldest added result when full. You can change the limit as your needs change.
- **`LRUCache`** lets several users share results they recently used. Once nobody needs a saved result, the cache lets it go.

## Example

For example, if you count the words in the same text several times, save the count rather than read through the text every time.

```rust
use tiny_cache::FifoCache;

fn count_words(saved: &mut FifoCache<String, usize>, text: String) -> usize {
    if let Some(&count) = saved.get(&text) {
        return count;
    }

    let count = text.split_whitespace().count();
    saved.insert(text, count);
    count
}

let mut saved = FifoCache::new(100);

assert_eq!(count_words(&mut saved, "Save results for later".into()), 4);
assert_eq!(count_words(&mut saved, "Save results for later".into()), 4);

saved.set_capacity(20);
```

## Share results between users

Choose `LRUCache` when different parts of your program need the same result. In Freya, several labels can reuse the work of preparing the same text for drawing. Removing one label should not discard work another label still needs.

Each user keeps its last two results by default. Call `utilize` to look for a saved result, `insert` if you need to create it, and `remove` when a user no longer needs its results.

Run the example showing both caches:

```sh
cargo run -p tiny-cache --example caches
```