bincache 0.5.1

ZitaneLabs binary 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
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

use std::hash::Hash;

use crate::{noop::Noop, Cache, CacheKey, CacheStrategy, CompressionStrategy, Result};

/// A builder for creating a new [Cache].
///
/// # Examples
/// ```
/// use bincache::{CacheBuilder, MemoryStrategy};
///
/// #[tokio::main(flavor = "current_thread")]
/// async fn main() {
///     let mut cache = CacheBuilder::default()
///         .with_strategy(MemoryStrategy::default())
///         .build().await
///         .unwrap();
///
///     cache.put("key", b"value".to_vec()).await.unwrap();
/// }
/// ```
#[derive(Debug, Default)]
pub struct CacheBuilder;

pub struct CacheBuilderWithStrategy<S> {
    strategy: S,
}

impl<S> Default for CacheBuilderWithStrategy<S>
where
    S: Default + CacheStrategy,
{
    fn default() -> Self {
        CacheBuilderWithStrategy {
            strategy: S::default(),
        }
    }
}

pub struct CacheBuilderWithCompression<C> {
    compressor: C,
}

impl<C> Default for CacheBuilderWithCompression<C>
where
    C: Default + CompressionStrategy,
{
    fn default() -> Self {
        CacheBuilderWithCompression {
            compressor: C::default(),
        }
    }
}

pub struct CacheBuilderWithCompressionAndStrategy<S, C> {
    strategy: S,
    compressor: C,
}

impl<S, C> Default for CacheBuilderWithCompressionAndStrategy<S, C>
where
    S: Default + CacheStrategy,
    C: Default + CompressionStrategy,
{
    fn default() -> Self {
        CacheBuilderWithCompressionAndStrategy {
            strategy: S::default(),
            compressor: C::default(),
        }
    }
}

impl CacheBuilder {
    /// Add a strategy to the cache
    pub fn with_strategy<S>(self, strategy: S) -> CacheBuilderWithStrategy<S>
    where
        S: CacheStrategy,
    {
        CacheBuilderWithStrategy { strategy }
    }

    /// Add a compression algorithm to the cache
    pub fn with_compression<C>(self, compressor: C) -> CacheBuilderWithCompression<C>
    where
        C: CompressionStrategy,
    {
        CacheBuilderWithCompression { compressor }
    }
}

impl<C> CacheBuilderWithCompression<C> {
    /// Add a strategy to the cache
    pub fn with_strategy<S>(self, strategy: S) -> CacheBuilderWithCompressionAndStrategy<S, C> {
        {
            CacheBuilderWithCompressionAndStrategy {
                strategy,
                compressor: self.compressor,
            }
        }
    }
}

impl<S> CacheBuilderWithStrategy<S>
where
    S: CacheStrategy + Send,
{
    /// Add a compression algorithm to the cache
    pub fn with_compression<C>(self, compressor: C) -> CacheBuilderWithCompressionAndStrategy<S, C>
    where
        C: CompressionStrategy,
    {
        CacheBuilderWithCompressionAndStrategy {
            strategy: self.strategy,
            compressor,
        }
    }

    /// Build the cache without using compression
    pub async fn build<K>(self) -> Result<Cache<K, S, Noop>>
    where
        K: CacheKey + Eq + Hash + Sync + Send,
    {
        Cache::new(self.strategy, None).await
    }
}

impl<S, C> CacheBuilderWithCompressionAndStrategy<S, C>
where
    S: CacheStrategy + Send,
    C: CompressionStrategy,
{
    pub async fn build<K>(self) -> Result<Cache<K, S, C>>
    where
        K: CacheKey + Eq + Hash + Sync + Send,
        C: CompressionStrategy + Sync + Send,
    {
        Cache::new(self.strategy, Some(self.compressor)).await
    }
}

#[cfg(test)]
mod tests {
    use crate::{async_test, noop::Noop};

    use super::*;

    async_test! {
        async fn test_default() {
            _ = CacheBuilder::default();
        }

        async fn test_type_aliased() {
            type NoopCacheBuilder = CacheBuilderWithStrategy<Noop>;
            _ = NoopCacheBuilder::default().build::<String>();
        }

        async fn test_key_inference() {
            let mut cache = CacheBuilder::default().with_strategy(Noop).build().await.unwrap();
            cache.put("test".to_string(), vec![]).await.unwrap();
        }
    }
}