tower-http-cache-plus 0.0.2

HTTP response caching middleware with integrated compression
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

use super::{super::configuration::*, hooks::*};

use kutil::http::*;

/// Encodings in order from most preferred to least.
///
/// We are generally preferring to optimize for compute rather than bandwidth.
///
/// GZip and Deflate are almost identical, but we prefer GZip because it allows clients to check
/// for errors.
pub const ENCODINGS_BY_PREFERENCE: &[EncodingHeaderValue] = &[
    EncodingHeaderValue::Brotli,
    EncodingHeaderValue::GZip,
    EncodingHeaderValue::Deflate,
    EncodingHeaderValue::Zstandard,
];

//
// MiddlewareCachingConfiguration
//

/// Middleware caching configuration.
pub struct MiddlewareCachingConfiguration<RequestBodyT, CacheT, CacheKeyT> {
    /// Cache.
    pub cache: Option<CacheT>,

    /// Cacheable by request (hook).
    pub cacheable_by_request: Option<CacheableHook>,

    /// Cacheable by response (hook).
    pub cacheable_by_response: Option<CacheableHook>,

    /// Cache key (hook).
    pub cache_key: Option<CacheKeyHook<CacheKeyT, RequestBodyT>>,

    /// Inner configuration.
    pub inner: CachingConfiguration,
}

impl<RequestBodyT, CacheT, CacheKeyT> Default
    for MiddlewareCachingConfiguration<RequestBodyT, CacheT, CacheKeyT>
{
    fn default() -> Self {
        Self {
            cache: None,
            cacheable_by_request: None,
            cacheable_by_response: None,
            cache_key: None,
            inner: CachingConfiguration {
                min_body_size: 0,
                max_body_size: 1024 * 1024, // 1 MiB
                cacheable_by_default: true,
                cache_duration: None,
            },
        }
    }
}

impl<RequestBodyT, CacheT, CacheKeyT> Clone
    for MiddlewareCachingConfiguration<RequestBodyT, CacheT, CacheKeyT>
where
    CacheT: Clone,
{
    fn clone(&self) -> Self {
        // Unfortunately we can't get away with #[derive(Clone)]
        // The culprit is the RequestBodyT generic param in CacheKeyHookContext
        Self {
            cache: self.cache.clone(),
            cacheable_by_request: self.cacheable_by_request.clone(),
            cacheable_by_response: self.cacheable_by_response.clone(),
            cache_key: self.cache_key.clone(),
            inner: self.inner.clone(),
        }
    }
}

//
// MiddlewareEncodingConfiguration
//

/// Middleware encoding configuration.
#[derive(Clone)]
pub struct MiddlewareEncodingConfiguration {
    /// Enabled encodings in order of preference.
    pub enabled_encodings_by_preference: Option<Vec<EncodingHeaderValue>>,

    /// Encodable by request (hook).
    pub encodable_by_request: Option<EncodableHook>,

    /// Encodable by response (hook).
    pub encodable_by_response: Option<EncodableHook>,

    /// Inner configuration.
    pub inner: EncodingConfiguration,
}

impl Default for MiddlewareEncodingConfiguration {
    fn default() -> Self {
        Self {
            enabled_encodings_by_preference: Some(ENCODINGS_BY_PREFERENCE.into()),
            encodable_by_request: None,
            encodable_by_response: None,
            inner: EncodingConfiguration {
                min_body_size: 0,
                encodable_by_default: true,
                keep_identity_encoding: true,
            },
        }
    }
}