pub struct LruCacheConfig {
pub capacity: NonZeroUsize,
pub max_size: u64,
}Expand description
Configuration for an LRU (Least Recently Used) cache.
LRU evicts the least recently accessed items when the cache reaches capacity.
§Fields
capacity: Maximum number of entries the cache can hold. Each entry has memory overhead (~64-128 bytes) for keys, pointers, and metadata.max_size: Maximum total size in bytes for cached values. Set this based on your memory budget, not tou64::MAX. See module docs for sizing guidance.
§Sizing Recommendations
Always set meaningful values for both fields:
- In-memory cache:
max_size= memory budget for values;capacity=max_size/ average_value_size - Disk-based cache:
max_size= disk space allocation;capacity=max_size/ average_object_size
§Examples
use cache_rs::config::LruCacheConfig;
use cache_rs::LruCache;
use core::num::NonZeroUsize;
// 10MB cache for ~1KB average values → ~10,000 entries
let config = LruCacheConfig {
capacity: NonZeroUsize::new(10_000).unwrap(),
max_size: 10 * 1024 * 1024, // 10MB
};
let cache: LruCache<String, Vec<u8>> = LruCache::init(config, None);
// Small cache for tiny values (ints, bools) - capacity-limited
let config = LruCacheConfig {
capacity: NonZeroUsize::new(500).unwrap(),
max_size: 64 * 1024, // 64KB is ample for small values
};
let cache: LruCache<&str, i32> = LruCache::init(config, None);Fields§
§capacity: NonZeroUsizeMaximum number of key-value pairs the cache can hold. Account for ~64-128 bytes overhead per entry beyond value size.
max_size: u64Maximum total size in bytes for cached values.
Set based on your memory/disk budget. Avoid using u64::MAX.
Trait Implementations§
Source§impl Clone for LruCacheConfig
impl Clone for LruCacheConfig
Source§fn clone(&self) -> LruCacheConfig
fn clone(&self) -> LruCacheConfig
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for LruCacheConfig
impl Debug for LruCacheConfig
impl Copy for LruCacheConfig
Auto Trait Implementations§
impl Freeze for LruCacheConfig
impl RefUnwindSafe for LruCacheConfig
impl Send for LruCacheConfig
impl Sync for LruCacheConfig
impl Unpin for LruCacheConfig
impl UnwindSafe for LruCacheConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more