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

time/serde/timestamp/
mod.rs
