Struct GdsfCache 

pub struct GdsfCache<K, V, S = DefaultHashBuilder> { /* private fields */ }

An implementation of a Greedy Dual-Size Frequency (GDSF) cache.

Implementations

impl<K: Hash + Eq, V: Clone, S: BuildHasher> GdsfCache<K, V, S>

pub fn cap(&self) -> NonZeroUsize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn current_size(&self) -> u64

Returns the current total size of cached content.

pub fn max_size(&self) -> u64

Returns the maximum content size the cache can hold.

pub fn global_age(&self) -> f64

pub fn record_miss(&mut self, object_size: u64)

pub fn get<Q>(&mut self, key: &Q) -> Option<V>

where K: Borrow<Q> + Clone, Q: ?Sized + Hash + Eq,

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>

where K: Borrow<Q> + Clone, Q: ?Sized + Hash + Eq,

pub fn contains_key<Q>(&self, key: &Q) -> bool

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

pub fn put(&mut self, key: K, val: V, size: u64) -> Option<V>

where K: Clone,

pub fn pop<Q>(&mut self, key: &Q) -> Option<V>

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

pub fn clear(&mut self)

impl<K: Hash + Eq, V: Clone> GdsfCache<K, V, DefaultHashBuilder>

pub fn init(config: GdsfCacheConfig, hasher: Option<DefaultHashBuilder>) -> Self

Creates a new GDSF cache from a configuration.

This is the recommended way to create a GDSF cache. All configuration is specified through the GdsfCacheConfig struct.

Arguments

• config - Configuration specifying capacity and optional size limit/initial age
• hasher - Optional custom hash builder. Pass None to use the default.

Example

use cache_rs::GdsfCache;
use cache_rs::config::GdsfCacheConfig;
use core::num::NonZeroUsize;

// Simple capacity-only cache
let config = GdsfCacheConfig {
    capacity: NonZeroUsize::new(100).unwrap(),
    initial_age: 0.0,
    max_size: u64::MAX,
};
let mut cache: GdsfCache<&str, i32> = GdsfCache::init(config, None);
cache.put("key", 42, 1);

// Cache with size limit (recommended for GDSF)
let config = GdsfCacheConfig {
    capacity: NonZeroUsize::new(1000).unwrap(),
    initial_age: 0.0,
    max_size: 10 * 1024 * 1024,  // 10MB
};
let cache: GdsfCache<String, Vec<u8>> = GdsfCache::init(config, None);

Trait Implementations

impl<K: Hash + Eq, V: Clone, S: BuildHasher> CacheMetrics for GdsfCache<K, V, S>

fn metrics(&self) -> BTreeMap<String, f64>

Returns all metrics as key-value pairs in deterministic order

fn algorithm_name(&self) -> &'static str

Algorithm name for identification

impl<K: Debug, V: Debug, S: Debug> Debug for GdsfCache<K, V, S>

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

Formats the value using the given formatter.