tinytime 0.15.0

Low overhead implementation of time-related concepts.
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use core::fmt;
use std::str::FromStr;

use serde::Deserializer;
use serde::de::Error;
use serde::de::Visitor;

use crate::Duration;
use crate::Time;

#[cfg(feature = "chrono")]
impl Time {
    /// Helper method for deserializing an RFC 3339 string with `serde`.
    ///
    /// # Examples
    /// ```
    /// use tinytime::Duration;
    /// use tinytime::Time;
    ///
    /// #[derive(serde::Deserialize)]
    /// struct MyStruct {
    ///     #[serde(deserialize_with = "Time::deserialize_rfc3339")]
    ///     my_time: Time,
    /// }
    ///
    /// let json = r#"{ "my_time": "1970-01-01T02:51:00Z" }"#;
    /// let decoded: MyStruct = serde_json::from_str(json).unwrap();
    /// assert_eq!(
    ///     Time::EPOCH + Duration::hours(2) + Duration::minutes(51),
    ///     decoded.my_time
    /// );
    /// ```
    pub fn deserialize_rfc3339<'de, D>(value: D) -> Result<Time, D::Error>
    where
        D: Deserializer<'de>,
    {
        value.deserialize_str(TimeVisitor)
    }
}

#[cfg(feature = "chrono")]
struct TimeVisitor;

#[cfg(feature = "chrono")]
impl Visitor<'_> for TimeVisitor {
    type Value = Time;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> std::fmt::Result {
        formatter.write_str("an RFC 3339 string")
    }

    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
    where
        E: Error,
    {
        Time::parse_from_rfc3339(v).map_err(|e| E::custom(e.to_string()))
    }
}

impl Duration {
    /// Helper method for deserializing a duration string with `serde`.
    ///
    /// # Examples
    /// ```
    /// use tinytime::Duration;
    ///
    /// #[derive(serde::Deserialize)]
    /// struct MyStruct {
    ///     #[serde(deserialize_with = "Duration::deserialize_str")]
    ///     my_duration: Duration,
    /// }
    ///
    /// let json = r#"{ "my_duration": "1h20s" }"#;
    /// let decoded: MyStruct = serde_json::from_str(json).unwrap();
    /// assert_eq!(
    ///     Duration::hours(1) + Duration::seconds(20),
    ///     decoded.my_duration
    /// );
    /// ```
    pub fn deserialize_str<'de, D>(value: D) -> Result<Duration, D::Error>
    where
        D: Deserializer<'de>,
    {
        value.deserialize_str(DurationVisitor)
    }
}

struct DurationVisitor;

impl Visitor<'_> for DurationVisitor {
    type Value = Duration;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> std::fmt::Result {
        formatter.write_str("a duration string")
    }

    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
    where
        E: Error,
    {
        Duration::from_str(v).map_err(|e| E::custom(e.to_string()))
    }
}

#[cfg(test)]
mod test {
    use crate::Duration;
    use crate::Time;
    use crate::TimeWindow;

    #[test]
    fn serde_json_time() {
        for expected in [Time::hours(7), Time::EPOCH, Time::MAX] {
            let encoded = serde_json::to_string(&expected).unwrap();
            let actual = serde_json::from_str(&encoded).unwrap();
            assert_eq!(expected, actual);
        }
    }

    #[test]
    fn serde_json_duration() {
        for expected in [
            Duration::millis(77777),
            Duration::MAX,
            Duration::ZERO,
            -Duration::MAX,
        ] {
            let encoded = serde_json::to_string(&expected).unwrap();
            let actual: Duration = serde_json::from_str(&encoded).unwrap();
            assert_eq!(expected, actual);
        }
    }

    #[test]
    fn serde_json_time_window() {
        for expected in [
            TimeWindow::new(Time::hours(7), Time::hours(19)),
            TimeWindow::widest(),
        ] {
            let encoded = serde_json::to_string(&expected).unwrap();
            let actual: TimeWindow = serde_json::from_str(&encoded).unwrap();
            assert_eq!(expected, actual);
        }
    }
}