1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
// SPDX-FileCopyrightText: 2023 Shun Sakai
//
// SPDX-License-Identifier: Apache-2.0 OR MIT
//! Use [Unix time] when serializing and deserializing an [`Option<FileTime>`].
//!
//! Use this module in combination with Serde's [`with`] attribute.
//!
//! # Examples
//!
//! ```
//! use nt_time::{
//! serde::{Deserialize, Serialize},
//! serde_with::unix_time,
//! FileTime,
//! };
//!
//! #[derive(Debug, Deserialize, PartialEq, Serialize)]
//! struct DateTime(#[serde(with = "unix_time::option")] Option<FileTime>);
//!
//! let json = serde_json::to_string(&DateTime(Some(FileTime::UNIX_EPOCH))).unwrap();
//! assert_eq!(json, "0");
//!
//! assert_eq!(
//! serde_json::from_str::<DateTime>(&json).unwrap(),
//! DateTime(Some(FileTime::UNIX_EPOCH))
//! );
//!
//! let json = serde_json::to_string(&DateTime(None)).unwrap();
//! assert_eq!(json, "null");
//!
//! assert_eq!(
//! serde_json::from_str::<DateTime>(&json).unwrap(),
//! DateTime(None)
//! );
//! ```
//!
//! [Unix time]: https://en.wikipedia.org/wiki/Unix_time
//! [`with`]: https://serde.rs/field-attrs.html#with
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};
use crate::FileTime;
#[allow(clippy::missing_errors_doc)]
/// Serializes an [`Option<FileTime>`] into the given Serde serializer.
///
/// This serializes using [Unix time].
///
/// [Unix time]: https://en.wikipedia.org/wiki/Unix_time
pub fn serialize<S: Serializer>(ft: &Option<FileTime>, serializer: S) -> Result<S::Ok, S::Error> {
ft.map(FileTime::to_unix_time).serialize(serializer)
}
#[allow(clippy::missing_errors_doc)]
/// Deserializes an [`Option<FileTime>`] from the given Serde deserializer.
///
/// This deserializes from its [Unix time].
///
/// [Unix time]: https://en.wikipedia.org/wiki/Unix_time
pub fn deserialize<'de, D: Deserializer<'de>>(
deserializer: D,
) -> Result<Option<FileTime>, D::Error> {
Option::deserialize(deserializer)?
.map(FileTime::from_unix_time)
.transpose()
.map_err(D::Error::custom)
}
#[cfg(test)]
mod tests {
use core::time::Duration;
use serde_test::{
assert_de_tokens, assert_de_tokens_error, assert_ser_tokens, assert_tokens, Token,
};
use super::*;
#[derive(Debug, Deserialize, PartialEq, Serialize)]
struct Test(#[serde(with = "crate::serde_with::unix_time::option")] Option<FileTime>);
#[test]
fn serde() {
assert_tokens(
&Test(Some(FileTime::NT_TIME_EPOCH)),
&[
Token::NewtypeStruct { name: "Test" },
Token::Some,
Token::I64(-11_644_473_600),
],
);
assert_tokens(
&Test(Some(FileTime::UNIX_EPOCH)),
&[
Token::NewtypeStruct { name: "Test" },
Token::Some,
Token::I64(i64::default()),
],
);
assert_tokens(
&Test(None),
&[Token::NewtypeStruct { name: "Test" }, Token::None],
);
}
#[test]
fn serialize() {
assert_ser_tokens(
&Test(Some(FileTime::MAX)),
&[
Token::NewtypeStruct { name: "Test" },
Token::Some,
Token::I64(1_833_029_933_770),
],
);
}
#[test]
fn deserialize() {
assert_de_tokens(
&Test(Some(FileTime::MAX - Duration::from_nanos(955_161_500))),
&[
Token::NewtypeStruct { name: "Test" },
Token::Some,
Token::I64(1_833_029_933_770),
],
);
}
#[test]
fn deserialize_error() {
assert_de_tokens_error::<Test>(
&[
Token::NewtypeStruct { name: "Test" },
Token::Some,
Token::I64(-11_644_473_601),
],
"date and time is before `1601-01-01 00:00:00 UTC`",
);
assert_de_tokens_error::<Test>(
&[
Token::NewtypeStruct { name: "Test" },
Token::Some,
Token::I64(1_833_029_933_771),
],
"date and time is after `+60056-05-28 05:36:10.955161500 UTC`",
);
}
#[test]
fn serialize_json() {
assert_eq!(
serde_json::to_string(&Test(Some(FileTime::NT_TIME_EPOCH))).unwrap(),
"-11644473600"
);
assert_eq!(
serde_json::to_string(&Test(Some(FileTime::UNIX_EPOCH))).unwrap(),
"0"
);
assert_eq!(
serde_json::to_string(&Test(Some(FileTime::MAX))).unwrap(),
"1833029933770"
);
assert_eq!(serde_json::to_string(&Test(None)).unwrap(), "null");
}
#[test]
fn deserialize_json() {
assert_eq!(
serde_json::from_str::<Test>("-11644473600").unwrap(),
Test(Some(FileTime::NT_TIME_EPOCH))
);
assert_eq!(
serde_json::from_str::<Test>("0").unwrap(),
Test(Some(FileTime::UNIX_EPOCH))
);
assert_eq!(
serde_json::from_str::<Test>("1833029933770").unwrap(),
Test(Some(FileTime::MAX - Duration::from_nanos(955_161_500)))
);
assert_eq!(serde_json::from_str::<Test>("null").unwrap(), Test(None));
}
}