hydracache-core 0.17.0

Core runtime types and traits for HydraCache.
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
86
87
88
89
90

use std::time::Duration;

use crate::TagSet;

/// Per-entry cache behavior.
///
/// Options are passed to `put`, `get_or_load`, and loader helper methods.
///
/// # Example
///
/// ```rust
/// use std::time::Duration;
///
/// use hydracache_core::CacheOptions;
///
/// let options = CacheOptions::new()
///     .ttl(Duration::from_secs(60))
///     .tags(["users", "user:42"]);
///
/// assert_eq!(options.ttl_value(), Some(Duration::from_secs(60)));
/// assert_eq!(options.tags_value(), &["users".to_owned(), "user:42".to_owned()]);
/// ```
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct CacheOptions {
    ttl: Option<Duration>,
    tags: Vec<String>,
}

impl CacheOptions {
    /// Create empty cache options.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set a per-entry TTL.
    pub fn ttl(mut self, ttl: Duration) -> Self {
        self.ttl = Some(ttl);
        self
    }

    /// Attach one tag used by `invalidate_tag`.
    pub fn tag(mut self, tag: impl Into<String>) -> Self {
        self.tags.push(tag.into());
        self
    }

    /// Attach tags used by `invalidate_tag`.
    pub fn tags<I, S>(mut self, tags: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: Into<String>,
    {
        self.tags = tags.into_iter().map(Into::into).collect();
        self
    }

    /// Replace tags from a [`TagSet`].
    pub fn tag_set(mut self, tags: TagSet) -> Self {
        self.tags = tags.into_vec();
        self
    }

    /// Return the configured TTL, if any.
    pub fn ttl_value(&self) -> Option<Duration> {
        self.ttl
    }

    /// Return tags attached to this entry.
    pub fn tags_value(&self) -> &[String] {
        &self.tags
    }
}

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

    #[test]
    fn cache_options_tag_set_replaces_existing_tags() {
        let options = CacheOptions::new()
            .tag("old")
            .tag_set(TagSet::new().tag("new").entity("user", 42));

        assert_eq!(
            options.tags_value(),
            &["new".to_owned(), "user:42".to_owned()]
        );
    }
}