http_types_rs/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_rs::Result<()> {
16/// #
17/// use http_types_rs::Response;
18/// use http_types_rs::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 { at: SystemTime::now() }
49    }
50
51    /// Create a new instance from headers.
52    pub fn from_headers(headers: impl AsRef<Headers>) -> crate::Result<Option<Self>> {
53        let headers = match headers.as_ref().get(DATE) {
54            Some(headers) => headers,
55            None => return Ok(None),
56        };
57
58        // If we successfully parsed the header then there's always at least one
59        // entry. We want the last entry.
60        let value = headers.iter().last().unwrap();
61        let date: HttpDate = value.as_str().trim().parse().map_err(|mut e: crate::Error| {
62            e.set_status(400);
63            e
64        })?;
65        let at = date.into();
66        Ok(Some(Self { at }))
67    }
68}
69
70impl Header for Date {
71    fn header_name(&self) -> HeaderName {
72        DATE
73    }
74
75    fn header_value(&self) -> HeaderValue {
76        let date: HttpDate = self.at.into();
77        let output = format!("{}", date);
78
79        // SAFETY: the internal string is validated to be ASCII.
80        unsafe { HeaderValue::from_bytes_unchecked(output.into()) }
81    }
82}
83
84impl From<Date> for SystemTime {
85    fn from(date: Date) -> Self {
86        date.at
87    }
88}
89
90impl From<SystemTime> for Date {
91    fn from(time: SystemTime) -> Self {
92        Self { at: time }
93    }
94}
95
96impl PartialEq<SystemTime> for Date {
97    fn eq(&self, other: &SystemTime) -> bool {
98        &self.at == other
99    }
100}
101
102#[cfg(test)]
103mod test {
104    use super::*;
105    use crate::headers::Headers;
106    use std::time::Duration;
107
108    #[test]
109    fn smoke() -> crate::Result<()> {
110        let now = SystemTime::now();
111        let date = Date::new(now);
112
113        let mut headers = Headers::new();
114        date.apply_header(&mut headers);
115
116        let date = Date::from_headers(headers)?.unwrap();
117
118        // Validate we're within 1 second accurate of the system time.
119        assert!(now.duration_since(date.into())? <= Duration::from_secs(1));
120        Ok(())
121    }
122
123    #[test]
124    fn bad_request_on_parse_error() {
125        let mut headers = Headers::new();
126        headers.insert(DATE, "<nori ate the tag. yum.>").unwrap();
127        let err = Date::from_headers(headers).unwrap_err();
128        assert_eq!(err.status(), 400);
129    }
130}