CLru

An LRU cache implementation with constant time operations.

The cache is backed by a HashMap and thus offers a O(1) time complexity (amortized average) for common operations:

get / get_mut
put / pop
peek / peek_mut

Disclaimer

Most of the API, documentation, examples and tests have been heavily inspired by the lru crate. I want to thank jeromefroe for his work without which this crate would have probably never has been released.

Differences with lru

The main differences are:

Smaller amount of unsafe code. Unsafe code is not bad in itself as long as it is thoroughly reviewed and understood but can be surprisingly hard to get right. Reducing the amount of unsafe code should hopefully reduce bugs or undefined behaviors.
API closer to the standard HashMap collection which allows to lookup with Borrow-ed version of the key.

Example

Below is a simple example of how to instantiate and use this LRU cache.

use clru::CLruCache;

fn main() {
    let mut cache = CLruCache::new(2);
    cache.put("apple".to_string(), 3);
    cache.put("banana".to_string(), 2);

    assert_eq!(cache.get("apple"), Some(&3));
    assert_eq!(cache.get("banana"), Some(&2));
    assert!(cache.get("pear").is_none());

    assert_eq!(cache.put("banana", 4), Some(2));
    assert_eq!(cache.put("pear", 5), None);

    assert_eq!(cache.get("pear"), Some(&5));
    assert_eq!(cache.get("banana"), Some(&4));
    assert!(cache.get("apple").is_none());

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

    assert_eq!(cache.get("banana"), Some(&6));
}

Tests

Each contribution is tested with regular compiler, miri, and 4 flavors of sanitizer (address, memory, thread and leak). This should help catch bugs sooner than later.

TODO