hitbox-http 0.2.1

Cacheable HTTP Request and Response
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

//! Cache status extension for HTTP responses.
//!
//! This module provides the [`CacheStatusExt`] implementation for HTTP responses,
//! allowing cache status information to be attached as headers.

use hitbox::{CacheStatus, CacheStatusExt};
use http::{HeaderValue, header::HeaderName};
use hyper::body::Body as HttpBody;

use crate::CacheableHttpResponse;

/// Default header name for cache status (HIT/MISS/STALE).
///
/// The value is `x-cache-status`. Use builder methods on cache middleware
/// to customize the header name.
pub const DEFAULT_CACHE_STATUS_HEADER: HeaderName = HeaderName::from_static("x-cache-status");

impl<ResBody> CacheStatusExt for CacheableHttpResponse<ResBody>
where
    ResBody: HttpBody,
{
    type Config = HeaderName;

    fn cache_status(&mut self, status: CacheStatus, config: &Self::Config) {
        let value = match status {
            CacheStatus::Hit => HeaderValue::from_static("HIT"),
            CacheStatus::Miss => HeaderValue::from_static("MISS"),
            CacheStatus::Stale => HeaderValue::from_static("STALE"),
        };
        self.parts.headers.insert(config.clone(), value);
    }
}