tower-resilience-cache 0.1.0

Response caching/memoization for Tower services
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! Event types for cache.

use std::time::Instant;
use tower_resilience_core::ResilienceEvent;

/// Events emitted by the cache.
#[derive(Debug, Clone)]
pub enum CacheEvent {
    /// A cache hit occurred.
    Hit {
        /// The name of the cache instance.
        pattern_name: String,
        /// When the event occurred.
        timestamp: Instant,
    },
    /// A cache miss occurred.
    Miss {
        /// The name of the cache instance.
        pattern_name: String,
        /// When the event occurred.
        timestamp: Instant,
    },
    /// An entry was evicted from the cache.
    Eviction {
        /// The name of the cache instance.
        pattern_name: String,
        /// When the event occurred.
        timestamp: Instant,
    },
}

impl ResilienceEvent for CacheEvent {
    fn event_type(&self) -> &'static str {
        match self {
            CacheEvent::Hit { .. } => "cache_hit",
            CacheEvent::Miss { .. } => "cache_miss",
            CacheEvent::Eviction { .. } => "cache_eviction",
        }
    }

    fn timestamp(&self) -> Instant {
        match self {
            CacheEvent::Hit { timestamp, .. }
            | CacheEvent::Miss { timestamp, .. }
            | CacheEvent::Eviction { timestamp, .. } => *timestamp,
        }
    }

    fn pattern_name(&self) -> &str {
        match self {
            CacheEvent::Hit { pattern_name, .. }
            | CacheEvent::Miss { pattern_name, .. }
            | CacheEvent::Eviction { pattern_name, .. } => pattern_name,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_event_types() {
        let now = Instant::now();

        let hit = CacheEvent::Hit {
            pattern_name: "test".to_string(),
            timestamp: now,
        };
        assert_eq!(hit.event_type(), "cache_hit");
        assert_eq!(hit.pattern_name(), "test");

        let miss = CacheEvent::Miss {
            pattern_name: "test".to_string(),
            timestamp: now,
        };
        assert_eq!(miss.event_type(), "cache_miss");

        let eviction = CacheEvent::Eviction {
            pattern_name: "test".to_string(),
            timestamp: now,
        };
        assert_eq!(eviction.event_type(), "cache_eviction");
    }
}