cleep 0.1.0

Clocksweep Cache implementation in Rust
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
61
62
63
64

# `cleep` is a Clocksweep Cache implementation in Rust

[![Build Status](https://github.com/mirrajabi/cleep/actions/workflows/test.yaml/badge.svg)](https://github.com/mirrajabi/cleep/actions)
[![Crates.io](https://img.shields.io/crates/v/cleep.svg)](https://crates.io/crates/cleep)
[![Documentation](https://docs.rs/cleep/badge.svg)](https://docs.rs/cleep)

Use it to keep your hot juicy records in memory for fast access.

## Usage

```bash
cargo add cleep
```

### Single Threaded example

```rust
use cleep::ClockCache;

let mut cache = ClockCache::<usize, usize, _, 4>::new(|key| fetcher(key));
let v = cache.get(&123);
```

### Thread safe example

```rust
use std::sync::Arc;
use std::thread;
use cleep::ConcurrentClockCache;

const SHARD_CAP: usize = 64;
const SHARDS: usize = 16;

let cache = Arc::new(ConcurrentClockCache::<usize, usize, _, SHARD_CAP, SHARDS>::new(
    mock_fetcher,
));
let mut handles = vec![];

let n_threads = thread::available_parallelism().unwrap().get();
for t in 0..n_threads {
    let cache_ref = Arc::clone(&cache);
    handles.push(thread::spawn(move || {
        for i in 0..100_000 {
            let key = (i + t * 10) % 500;
            let val = cache_ref.get(&key);
            assert_eq!(val, mock_fetcher(&key));
        }
    }));
}

for handle in handles {
    handle.join().unwrap();
}
```

### Limitations

The cache capacity in single-threaded implementation and the shard size and shard capacity in the concurrent version must
be a power of two. This is so that we can avoid branching and modulo operations as much as possible on the hot paths and
rely on bitwise operations.

### License

This project is dual-licensed under the MIT and Apache-2.0 licenses. You can choose either license for your use.