Skip to main content

SlruCacheConfig

Struct SlruCacheConfig 

Source
pub struct SlruCacheConfig {
    pub capacity: NonZeroUsize,
    pub protected_capacity: NonZeroUsize,
    pub max_size: u64,
}
Expand description

Configuration for an SLRU (Segmented LRU) cache.

SLRU divides the cache into two segments: a probationary segment for new entries and a protected segment for frequently accessed entries.

§Fields

  • capacity: Total number of entries the cache can hold. Each entry has memory overhead (~64-128 bytes) for keys, pointers, and metadata.
  • protected_capacity: Size of the protected segment (must be < capacity). Typically 20% of total capacity for hot items.
  • max_size: Maximum total size in bytes for cached values. Set this based on your memory budget, not to u64::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::SlruCacheConfig;
use cache_rs::SlruCache;
use core::num::NonZeroUsize;

// 10MB cache for ~1KB values, 20% protected
let config = SlruCacheConfig {
    capacity: NonZeroUsize::new(10_000).unwrap(),
    protected_capacity: NonZeroUsize::new(2_000).unwrap(),
    max_size: 10 * 1024 * 1024,  // 10MB
};
let cache: SlruCache<String, Vec<u8>> = SlruCache::init(config, None);

// Small cache for config values, 20% protected
let config = SlruCacheConfig {
    capacity: NonZeroUsize::new(500).unwrap(),
    protected_capacity: NonZeroUsize::new(100).unwrap(),
    max_size: 64 * 1024,  // 64KB is ample for small values
};
let cache: SlruCache<&str, i32> = SlruCache::init(config, None);

Fields§

§capacity: NonZeroUsize

Total capacity of the cache (protected + probationary). Account for ~64-128 bytes overhead per entry beyond value size.

§protected_capacity: NonZeroUsize

Maximum size for the protected segment (must be < capacity). Typically 20% of capacity for frequently accessed “hot” items.

§max_size: u64

Maximum total size in bytes for cached values. Set based on your memory/disk budget. Avoid using u64::MAX.

Trait Implementations§

Source§

impl Clone for SlruCacheConfig

Source§

fn clone(&self) -> SlruCacheConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SlruCacheConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Copy for SlruCacheConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.