tinylfu-cached 0.0.4

High performance, LFU based in-memory cache.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use std::time::Duration;
use crate::cache::clock::ClockType;
use crate::cache::types::TotalShards;

/// Defines the config for `crate::cache::expiration::TTLTicker`
/// TTLTicker is a shared lock based HashMap. Each shard holds a [`parking_lot::RwLock`] protected [`hashbrown::HashMap`]
/// `shards` define the total number of shards to be used inside `TTLTicker`
/// `tick_duration` defines the interval at which `TTLTicker` should run
/// `clock` defines an implementation of [`crate::cache::clock::Clock`] to be used to get the current time
pub(crate) struct TTLConfig {
    shards: TotalShards,
    tick_duration: Duration,
    clock: ClockType,
}

impl TTLConfig {
    pub(crate) fn new(shards: TotalShards, tick_duration: Duration, clock: ClockType) -> Self {
        TTLConfig {
            shards,
            tick_duration,
            clock,
        }
    }

    pub(crate) fn shards(&self) -> TotalShards { self.shards }

    pub(crate) fn tick_duration(&self) -> Duration { self.tick_duration }

    pub(crate) fn clock(&self) -> ClockType { self.clock.clone_box() }
}

#[cfg(test)]
mod tests {
    use std::time::Duration;
    use crate::cache::clock::SystemClock;
    use crate::cache::expiration::config::TTLConfig;

    #[test]
    fn ttl_shards() {
        let ttl_config = TTLConfig::new(4, Duration::from_millis(10), SystemClock::boxed());
        assert_eq!(4, ttl_config.shards());
    }

    #[test]
    fn ttl_tick_duration() {
        let ttl_config = TTLConfig::new(4, Duration::from_millis(20), SystemClock::boxed());
        assert_eq!(Duration::from_millis(20), ttl_config.tick_duration());
    }
}