Struct BoundedLruCache

Source

pub struct BoundedLruCache<K, V>where
    K: Hash + Eq + Clone,
{ /* private fields */ }

Expand description

Thread-safe bounded LRU cache.

Implements a least-recently-used eviction policy with configurable size limits and optional TTL expiration.

§Type Parameters

K - Cache key type (must implement Hash + Eq)
V - Cache value type

§Performance

Insert: O(1) amortized
Get: O(1) amortized
Eviction: O(1) amortized

Implementations§

Source §

impl<K, V> BoundedLruCache<K, V>
where K: Hash + Eq + Clone,

Source

pub fn new(config: CacheConfig) -> BoundedLruCache<K, V>

Create a new bounded LRU cache with the given configuration.

§Arguments

config - Cache configuration (size limits, TTL, etc.)

§Returns

A new bounded LRU cache instance.

§Examples

use perl_workspace_index::workspace::cache::{BoundedLruCache, CacheConfig};

let config = CacheConfig {
    max_items: 1000,
    max_bytes: 10 * 1024 * 1024, // 10MB
    ttl: None,
};
let cache: BoundedLruCache<String, String> = BoundedLruCache::new(config);

Source

pub fn default() -> BoundedLruCache<K, V>

Create a new cache with default configuration.

§Returns

A new bounded LRU cache with default limits (10,000 items, 50MB).

§Examples

use perl_workspace_index::workspace::cache::BoundedLruCache;

let cache: BoundedLruCache<String, String> = BoundedLruCache::default();

Source

pub fn insert_with_size(&self, key: K, value: V, size_bytes: usize) -> bool

Insert a value into the cache.

If the cache is at capacity, the least recently used entry will be evicted.

§Arguments

key - Cache key
value - Value to cache
size_bytes - Size of the value in bytes (for memory tracking)

§Returns

true if the value was inserted, false if evicted due to size limits.

§Examples

use perl_workspace_index::workspace::cache::BoundedLruCache;

let mut cache = BoundedLruCache::default();
cache.insert_with_size("key", "value", 5);

Source

pub fn insert(&self, key: K, value: V)
where V: EstimateSize,

Insert a value into the cache with estimated size.

Uses a simple size estimation based on the value’s memory representation.

§Arguments

key - Cache key
value - Value to cache

§Returns

true if the value was inserted, false if evicted.

§Examples

use perl_workspace_index::workspace::cache::BoundedLruCache;

let mut cache = BoundedLruCache::default();
cache.insert("key", "value");

Source

pub fn get(&self, key: &K) -> Option<V>
where V: Clone,

Get a value from the cache.

Returns None if the key is not found or the entry has expired.

§Arguments

key - Cache key to look up

§Returns

Some(&V) if found and not expired, None otherwise.

§Examples

use perl_workspace_index::workspace::cache::BoundedLruCache;

let mut cache = BoundedLruCache::default();
cache.insert("key", "value");
assert_eq!(cache.get("key"), Some(&"value"));

Source

pub fn peek(&self, key: &K) -> Option<V>
where V: Clone,

Peek a value from the cache without changing hit/miss counters.

Expired entries are still removed so stale data does not linger.

Source

pub fn remove(&self, key: &K) -> Option<V>
where V: Clone,

Remove a value from the cache.

§Arguments

key - Cache key to remove

§Returns

Some(V) if the entry was removed, None if not found.

§Examples

use perl_workspace_index::workspace::cache::BoundedLruCache;

let mut cache = BoundedLruCache::default();
cache.insert("key", "value");
assert_eq!(cache.remove("key"), Some("value"));

Source

pub fn clear(&self)

Clear all entries from the cache.

§Examples

use perl_workspace_index::workspace::cache::BoundedLruCache;

let mut cache = BoundedLruCache::default();
cache.insert("key", "value");
cache.clear();
assert!(cache.is_empty());

Source

pub fn is_empty(&self) -> bool

Check if the cache is empty.

§Returns

true if the cache contains no entries, false otherwise.

Source

pub fn len(&self) -> usize

Get the number of items in the cache.

§Returns

The current number of cached items.

Source

pub fn stats(&self) -> CacheStats

Get cache statistics.

§Returns

A snapshot of the cache statistics.

§Examples

use perl_workspace_index::workspace::cache::BoundedLruCache;

let cache = BoundedLruCache::default();
let stats = cache.stats();
assert_eq!(stats.hits, 0);

Source