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