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