http_types_2/other/
date.rs

1use crate::headers::{Header, HeaderName, HeaderValue, Headers, DATE};
2use crate::utils::HttpDate;
3
4use std::time::SystemTime;
5
6/// The date and time at which the message originated.
7///
8/// # Specifications
9///
10/// - [RFC 7231, section 7.1.1.2: Date](https://tools.ietf.org/html/rfc7231#section-7.1.1.2)
11///
12/// # Examples
13///
14/// ```
15/// # fn main() -> http_types::Result<()> {
16/// #
17/// use http_types::Response;
18/// use http_types::other::Date;
19///
20/// use std::time::{Duration, SystemTime};
21///
22/// let now = SystemTime::now();
23/// let date = Date::new(now);
24///
25/// let mut res = Response::new(200);
26/// res.insert_header(&date, &date);
27///
28/// let date = Date::from_headers(res)?.unwrap();
29///
30/// // Validate we're within 1 second accurate of the system time.
31/// assert!(now.duration_since(date.into())? <= Duration::from_secs(1));
32/// #
33/// # Ok(()) }
34/// ```
35#[derive(Debug)]
36pub struct Date {
37    at: SystemTime,
38}
39
40impl Date {
41    /// Create a new instance.
42    pub fn new(at: SystemTime) -> Self {
43        Self { at }
44    }
45
46    /// Create a new instance with the date set to now.
47    pub fn now() -> Self {
48        Self {
49            at: SystemTime::now(),
50        }
51    }
52
53    /// Create a new instance from headers.
54    pub fn from_headers(headers: impl AsRef<Headers>) -> crate::Result<Option<Self>> {
55        let headers = match headers.as_ref().get(DATE) {
56            Some(headers) => headers,
57            None => return Ok(None),
58        };
59
60        // If we successfully parsed the header then there's always at least one
61        // entry. We want the last entry.
62        let value = headers.iter().last().unwrap();
63        let date: HttpDate = value
64            .as_str()
65            .trim()
66            .parse()
67            .map_err(|mut e: crate::Error| {
68                e.set_status(400);
69                e
70            })?;
71        let at = date.into();
72        Ok(Some(Self { at }))
73    }
74}
75
76impl Header for Date {
77    fn header_name(&self) -> HeaderName {
78        DATE
79    }
80
81    fn header_value(&self) -> HeaderValue {
82        let date: HttpDate = self.at.into();
83        let output = format!("{date}");
84
85        // SAFETY: the internal string is validated to be ASCII.
86        unsafe { HeaderValue::from_bytes_unchecked(output.into()) }
87    }
88}
89
90impl From<Date> for SystemTime {
91    fn from(date: Date) -> Self {
92        date.at
93    }
94}
95
96impl From<SystemTime> for Date {
97    fn from(time: SystemTime) -> Self {
98        Self { at: time }
99    }
100}
101
102impl PartialEq<SystemTime> for Date {
103    fn eq(&self, other: &SystemTime) -> bool {
104        &self.at == other
105    }
106}
107
108#[cfg(test)]
109mod test {
110    use super::*;
111    use crate::headers::Headers;
112    use std::time::Duration;
113
114    #[test]
115    fn smoke() -> crate::Result<()> {
116        let now = SystemTime::now();
117        let date = Date::new(now);
118
119        let mut headers = Headers::new();
120        date.apply_header(&mut headers);
121
122        let date = Date::from_headers(headers)?.unwrap();
123
124        // Validate we're within 1 second accurate of the system time.
125        assert!(now.duration_since(date.into())? <= Duration::from_secs(1));
126        Ok(())
127    }
128
129    #[test]
130    fn bad_request_on_parse_error() {
131        let mut headers = Headers::new();
132        headers.insert(DATE, "<nori ate the tag. yum.>").unwrap();
133        let err = Date::from_headers(headers).unwrap_err();
134        assert_eq!(err.status(), 400);
135    }
136}