Crate intrusive_lru_cache

Source
Expand description

§Intrusive LRU Cache

crates.io Documentation MIT/Apache-2 licensed

This crate provides an LRU Cache implementation that is based on combining an intrusive doubly linked list and an intrusive red-black tree, in the same node. Both data structures share the same allocations, which makes it quite efficient for a linked structure.

The LRUCache structure itself is not intrusive, and works like a regular cache. The intrusive part of the crate name is due to the intrusive structures used internally.

§Example

use intrusive_lru_cache::LRUCache;

let mut lru: LRUCache<&'static str, &'static str> = LRUCache::default();

lru.insert("a", "1");
lru.insert("b", "2");
lru.insert("c", "3");

let _ = lru.get("b"); // updates LRU order

assert_eq!(lru.pop(), Some(("a", "1")));
assert_eq!(lru.pop(), Some(("c", "3")));
assert_eq!(lru.pop(), Some(("b", "2")));
assert_eq!(lru.pop(), None);

§Cargo Features

  • atomic (default): Enables atomic links within the intrusive structures, making it thread-safe if K and V are Send/Sync. If you disable this feature, you can still use the cache in a single-threaded context.

Structs§

  • IntoIter
    An owning iterator over the key-value pairs in the cache, in order of most recently used to least recently used.
  • LRUCache
    LRU Cache implementation using intrusive collections.
  • SmartEntry
    An entry in the cache that can be used for for reading or writing, only updating the LRU order when the value is accessed mutably.

Enums§