time/serde/timestamp/
mod.rs

1//! Treat an [`OffsetDateTime`] as a [Unix timestamp] for the purposes of serde.
2//!
3//! Use this module in combination with serde's [`#[with]`][with] attribute.
4//!
5//! When deserializing, the offset is assumed to be UTC.
6//!
7//! [Unix timestamp]: https://en.wikipedia.org/wiki/Unix_time
8//! [with]: https://serde.rs/field-attrs.html#with
9
10pub mod microseconds;
11pub mod milliseconds;
12pub mod milliseconds_i64;
13pub mod nanoseconds;
14
15use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
16
17use crate::OffsetDateTime;
18
19/// Serialize an `OffsetDateTime` as its Unix timestamp
20pub fn serialize<S: Serializer>(
21    datetime: &OffsetDateTime,
22    serializer: S,
23) -> Result<S::Ok, S::Error> {
24    datetime.unix_timestamp().serialize(serializer)
25}
26
27/// Deserialize an `OffsetDateTime` from its Unix timestamp
28pub fn deserialize<'a, D: Deserializer<'a>>(deserializer: D) -> Result<OffsetDateTime, D::Error> {
29    OffsetDateTime::from_unix_timestamp(<_>::deserialize(deserializer)?)
30        .map_err(|err| de::Error::invalid_value(de::Unexpected::Signed(err.value), &err))
31}
32
33/// Treat an `Option<OffsetDateTime>` as a [Unix timestamp] for the purposes of
34/// serde.
35///
36/// Use this module in combination with serde's [`#[with]`][with] attribute.
37///
38/// When deserializing, the offset is assumed to be UTC.
39///
40/// [Unix timestamp]: https://en.wikipedia.org/wiki/Unix_time
41/// [with]: https://serde.rs/field-attrs.html#with
42pub mod option {
43    #[allow(clippy::wildcard_imports)]
44    use super::*;
45
46    /// Serialize an `Option<OffsetDateTime>` as its Unix timestamp
47    pub fn serialize<S: Serializer>(
48        option: &Option<OffsetDateTime>,
49        serializer: S,
50    ) -> Result<S::Ok, S::Error> {
51        option
52            .map(OffsetDateTime::unix_timestamp)
53            .serialize(serializer)
54    }
55
56    /// Deserialize an `Option<OffsetDateTime>` from its Unix timestamp
57    pub fn deserialize<'a, D: Deserializer<'a>>(
58        deserializer: D,
59    ) -> Result<Option<OffsetDateTime>, D::Error> {
60        Option::deserialize(deserializer)?
61            .map(OffsetDateTime::from_unix_timestamp)
62            .transpose()
63            .map_err(|err| de::Error::invalid_value(de::Unexpected::Signed(err.value), &err))
64    }
65}
time/serde/timestamp/mod.rs

time/serde/timestamp/
mod.rs
