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

use crate::headers::{HeaderName, HeaderValue, Headers, ToHeaderValues, AGE};
use crate::Status;

use std::fmt::Debug;
use std::option;
use std::time::Duration;

/// HTTP `Age` header
///
/// # Specifications
///
/// - [RFC 7234, section 5.1: Age](https://tools.ietf.org/html/rfc7234#section-5.1)
///
/// # Examples
///
/// ```
/// # fn main() -> http_types::Result<()> {
/// #
/// use http_types::Response;
/// use http_types::cache::Age;
///
/// let age = Age::from_secs(12);
///
/// let mut res = Response::new(200);
/// age.apply(&mut res);
///
/// let age = Age::from_headers(res)?.unwrap();
/// assert_eq!(age, Age::from_secs(12));
/// #
/// # Ok(()) }
/// ```
#[derive(Debug, Ord, PartialOrd, Eq, PartialEq)]
pub struct Age {
    dur: Duration,
}

impl Age {
    /// Create a new instance of `Age`.
    pub fn new(dur: Duration) -> Self {
        Self { dur }
    }

    /// Create a new instance of `Age` from secs.
    pub fn from_secs(secs: u64) -> Self {
        let dur = Duration::from_secs(secs);
        Self { dur }
    }

    /// Get the duration from the header.
    pub fn duration(&self) -> Duration {
        self.dur
    }

    /// Create an instance of `Age` from a `Headers` instance.
    pub fn from_headers(headers: impl AsRef<Headers>) -> crate::Result<Option<Self>> {
        let headers = match headers.as_ref().get(AGE) {
            Some(headers) => headers,
            None => return Ok(None),
        };

        // If we successfully parsed the header then there's always at least one
        // entry. We want the last entry.
        let header = headers.iter().last().unwrap();

        let num: u64 = header.as_str().parse().status(400)?;
        let dur = Duration::from_secs_f64(num as f64);

        Ok(Some(Self { dur }))
    }

    /// Insert a `HeaderName` + `HeaderValue` pair into a `Headers` instance.
    pub fn apply(&self, mut headers: impl AsMut<Headers>) {
        headers.as_mut().insert(AGE, self.value());
    }

    /// Get the `HeaderName`.
    pub fn name(&self) -> HeaderName {
        AGE
    }

    /// Get the `HeaderValue`.
    pub fn value(&self) -> HeaderValue {
        let output = self.dur.as_secs().to_string();

        // SAFETY: the internal string is validated to be ASCII.
        unsafe { HeaderValue::from_bytes_unchecked(output.into()) }
    }
}

impl ToHeaderValues for Age {
    type Iter = option::IntoIter<HeaderValue>;
    fn to_header_values(&self) -> crate::Result<Self::Iter> {
        // A HeaderValue will always convert into itself.
        Ok(self.value().to_header_values().unwrap())
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::headers::Headers;

    #[test]
    fn smoke() -> crate::Result<()> {
        let age = Age::new(Duration::from_secs(12));

        let mut headers = Headers::new();
        age.apply(&mut headers);

        let age = Age::from_headers(headers)?.unwrap();
        assert_eq!(age, Age::new(Duration::from_secs(12)));
        Ok(())
    }

    #[test]
    fn bad_request_on_parse_error() {
        let mut headers = Headers::new();
        headers.insert(AGE, "<nori ate the tag. yum.>");
        let err = Age::from_headers(headers).unwrap_err();
        assert_eq!(err.status(), 400);
    }
}