quickleaf 0.4.10

A simple and efficient in-memory cache with support for filtering, ordering, limiting results, event notifications and eventual persistence
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
91
92
93
94
95
96
97

//! Filtering functionality for cache queries.
//!
//! This module provides different types of filters that can be applied when listing cache entries.
//! Filters allow you to narrow down results based on key patterns.

/// Enum representing different filter types for cache queries.
///
/// Filters are used with the `list` method to narrow down results based on key patterns.
///
/// # Examples
///
/// ```
/// use quickleaf::Filter;
/// use quickleaf::Cache;
/// use quickleaf::ListProps;
/// use quickleaf::valu3::traits::ToValueBehavior;
///
/// let mut cache = Cache::new(10);
/// cache.insert("apple_pie", 1);
/// cache.insert("banana_split", 2);
/// cache.insert("apple_juice", 3);
/// cache.insert("grape_juice", 4);
///
/// // Filter by prefix
/// let start_filter = Filter::StartWith("apple".to_string());
/// let props = ListProps::default().filter(start_filter);
/// let results = cache.list(props).unwrap();
/// assert_eq!(results.len(), 2);
///
/// // Filter by suffix
/// let end_filter = Filter::EndWith("juice".to_string());
/// let props = ListProps::default().filter(end_filter);
/// let results = cache.list(props).unwrap();
/// assert_eq!(results.len(), 2);
///
/// // Filter by both prefix and suffix
/// let both_filter = Filter::StartAndEndWith("apple".to_string(), "juice".to_string());
/// let props = ListProps::default().filter(both_filter);
/// let results = cache.list(props).unwrap();
/// assert_eq!(results.len(), 1);
/// ```
#[derive(Debug)]
pub enum Filter {
    /// Filter keys that start with the specified string.
    ///
    /// # Examples
    ///
    /// ```
    /// use quickleaf::Filter;
    ///
    /// let filter = Filter::StartWith("user_".to_string());
    /// // This will match keys like "user_123", "user_session", etc.
    /// ```
    StartWith(String),

    /// Filter keys that end with the specified string.
    ///
    /// # Examples
    ///
    /// ```
    /// use quickleaf::Filter;
    ///
    /// let filter = Filter::EndWith("_cache".to_string());
    /// // This will match keys like "session_cache", "user_cache", etc.
    /// ```
    EndWith(String),

    /// Filter keys that start with the first string AND end with the second string.
    ///
    /// # Examples
    ///
    /// ```
    /// use quickleaf::Filter;
    ///
    /// let filter = Filter::StartAndEndWith("temp_".to_string(), "_data".to_string());
    /// // This will match keys like "temp_session_data", "temp_user_data", etc.
    /// ```
    StartAndEndWith(String, String),

    /// No filtering applied - returns all items.
    ///
    /// # Examples
    ///
    /// ```
    /// use quickleaf::Filter;
    ///
    /// let filter = Filter::None;
    /// // This will return all cache entries
    /// ```
    None,
}

impl Default for Filter {
    fn default() -> Self {
        Self::None
    }
}