ruma_common/serde/duration/
opt_secs.rs

Help
1//! De-/serialization functions for `Option<std::time::Duration>` objects represented as
2//! milliseconds.
3//!
4//! Delegates to `js_int::UInt` to ensure integer size is within bounds.
5
6use std::time::Duration;
7
8use js_int::UInt;
9use serde::{
10    de::{Deserialize, Deserializer},
11    ser::{Error, Serialize, Serializer},
12};
13
14/// Serialize an `Option<Duration>`.
15///
16/// Will fail if integer is greater than the maximum integer that can be
17/// unambiguously represented by an f64.
18pub fn serialize<S>(opt_duration: &Option<Duration>, serializer: S) -> Result<S::Ok, S::Error>
19where
20    S: Serializer,
21{
22    match opt_duration {
23        Some(duration) => match UInt::try_from(duration.as_secs()) {
24            Ok(uint) => uint.serialize(serializer),
25            Err(err) => Err(S::Error::custom(err)),
26        },
27        None => serializer.serialize_none(),
28    }
29}
30
31/// Deserializes an `Option<Duration>`.
32///
33/// Will fail if integer is greater than the maximum integer that can be
34/// unambiguously represented by an f64.
35pub fn deserialize<'de, D>(deserializer: D) -> Result<Option<Duration>, D::Error>
36where
37    D: Deserializer<'de>,
38{
39    Ok(Option::<UInt>::deserialize(deserializer)?.map(|secs| Duration::from_secs(secs.into())))
40}
41
42#[cfg(test)]
43mod tests {
44    use std::time::Duration;
45
46    use serde::{Deserialize, Serialize};
47    use serde_json::json;
48
49    #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
50    struct DurationTest {
51        #[serde(with = "super", default, skip_serializing_if = "Option::is_none")]
52        timeout: Option<Duration>,
53    }
54
55    #[test]
56    fn deserialize_some() {
57        let json = json!({ "timeout": 300 });
58
59        assert_eq!(
60            serde_json::from_value::<DurationTest>(json).unwrap(),
61            DurationTest { timeout: Some(Duration::from_secs(300)) },
62        );
63    }
64
65    #[test]
66    fn deserialize_none_by_absence() {
67        let json = json!({});
68
69        assert_eq!(
70            serde_json::from_value::<DurationTest>(json).unwrap(),
71            DurationTest { timeout: None },
72        );
73    }
74
75    #[test]
76    fn deserialize_none_by_null() {
77        let json = json!({ "timeout": null });
78
79        assert_eq!(
80            serde_json::from_value::<DurationTest>(json).unwrap(),
81            DurationTest { timeout: None },
82        );
83    }
84
85    #[test]
86    fn serialize_some() {
87        let request = DurationTest { timeout: Some(Duration::new(2, 0)) };
88        assert_eq!(serde_json::to_value(request).unwrap(), json!({ "timeout": 2 }));
89    }
90
91    #[test]
92    fn serialize_none() {
93        let request = DurationTest { timeout: None };
94        assert_eq!(serde_json::to_value(request).unwrap(), json!({}));
95    }
96}
ruma_common/serde/duration/opt_secs.rs

ruma_common/serde/duration/
opt_secs.rs
