nt-time 0.15.0

A Windows file time library
Documentation
// SPDX-FileCopyrightText: 2023 Shun Sakai
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! [Serde] support for [`FileTime`](super::FileTime).
//!
//! [Serde]: https://serde.rs/

#[cfg(test)]
mod tests {
    #[cfg(feature = "std")]
    use std::string::String;

    #[cfg(feature = "std")]
    use proptest::prop_assert_eq;
    use serde::{Deserialize, Serialize};
    use serde_test::Token;
    #[cfg(feature = "std")]
    use test_strategy::proptest;

    use super::super::FileTime;

    #[derive(Debug, Deserialize, Eq, PartialEq, Serialize)]
    struct Test {
        time: FileTime,
    }

    #[derive(Debug, Deserialize, Eq, PartialEq, Serialize)]
    struct TestOption {
        time: Option<FileTime>,
    }

    #[test]
    fn serde() {
        serde_test::assert_tokens(
            &Test {
                time: FileTime::NT_TIME_EPOCH,
            },
            &[
                Token::Struct {
                    name: "Test",
                    len: 1,
                },
                Token::Str("time"),
                Token::NewtypeStruct { name: "FileTime" },
                Token::U64(u64::MIN),
                Token::StructEnd,
            ],
        );
        serde_test::assert_tokens(
            &Test {
                time: FileTime::UNIX_EPOCH,
            },
            &[
                Token::Struct {
                    name: "Test",
                    len: 1,
                },
                Token::Str("time"),
                Token::NewtypeStruct { name: "FileTime" },
                Token::U64(116_444_736_000_000_000),
                Token::StructEnd,
            ],
        );
        serde_test::assert_tokens(
            &Test {
                time: FileTime::MAX,
            },
            &[
                Token::Struct {
                    name: "Test",
                    len: 1,
                },
                Token::Str("time"),
                Token::NewtypeStruct { name: "FileTime" },
                Token::U64(u64::MAX),
                Token::StructEnd,
            ],
        );
    }

    #[test]
    fn deserialize_error() {
        serde_test::assert_de_tokens_error::<Test>(
            &[
                Token::Struct {
                    name: "Test",
                    len: 1,
                },
                Token::Str("time"),
                Token::BorrowedStr("FileTime"),
            ],
            r#"invalid type: string "FileTime", expected tuple struct FileTime"#,
        );
        serde_test::assert_de_tokens_error::<Test>(
            &[
                Token::Struct {
                    name: "Test",
                    len: 1,
                },
                Token::Str("time"),
                Token::NewtypeStruct { name: "FileTime" },
                Token::Bool(bool::default()),
            ],
            "invalid type: boolean `false`, expected u64",
        );
        serde_test::assert_de_tokens_error::<Test>(
            &[
                Token::Struct {
                    name: "Test",
                    len: 1,
                },
                Token::Str("time"),
                Token::NewtypeStruct { name: "FileTime" },
                Token::I64(i64::MIN),
            ],
            "invalid value: integer `-9223372036854775808`, expected u64",
        );
    }

    #[test]
    fn serde_optional() {
        serde_test::assert_tokens(
            &TestOption {
                time: Some(FileTime::NT_TIME_EPOCH),
            },
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::Some,
                Token::NewtypeStruct { name: "FileTime" },
                Token::U64(u64::MIN),
                Token::StructEnd,
            ],
        );
        serde_test::assert_tokens(
            &TestOption {
                time: Some(FileTime::UNIX_EPOCH),
            },
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::Some,
                Token::NewtypeStruct { name: "FileTime" },
                Token::U64(116_444_736_000_000_000),
                Token::StructEnd,
            ],
        );
        serde_test::assert_tokens(
            &TestOption {
                time: Some(FileTime::MAX),
            },
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::Some,
                Token::NewtypeStruct { name: "FileTime" },
                Token::U64(u64::MAX),
                Token::StructEnd,
            ],
        );
        serde_test::assert_tokens(
            &TestOption { time: None },
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::None,
                Token::StructEnd,
            ],
        );
    }

    #[test]
    fn deserialize_optional_error() {
        serde_test::assert_de_tokens_error::<TestOption>(
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::BorrowedStr("FileTime"),
            ],
            r#"invalid type: string "FileTime", expected option"#,
        );
        serde_test::assert_de_tokens_error::<TestOption>(
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::Some,
                Token::BorrowedStr("FileTime"),
            ],
            r#"invalid type: string "FileTime", expected tuple struct FileTime"#,
        );
        serde_test::assert_de_tokens_error::<TestOption>(
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::Some,
                Token::NewtypeStruct { name: "FileTime" },
                Token::Bool(bool::default()),
            ],
            "invalid type: boolean `false`, expected u64",
        );
        serde_test::assert_de_tokens_error::<TestOption>(
            &[
                Token::Struct {
                    name: "TestOption",
                    len: 1,
                },
                Token::Str("time"),
                Token::Some,
                Token::NewtypeStruct { name: "FileTime" },
                Token::I64(i64::MIN),
            ],
            "invalid value: integer `-9223372036854775808`, expected u64",
        );
    }

    #[test]
    fn serialize_json() {
        assert_eq!(
            serde_json::to_string(&Test {
                time: FileTime::NT_TIME_EPOCH
            })
            .unwrap(),
            r#"{"time":0}"#
        );
        assert_eq!(
            serde_json::to_string(&Test {
                time: FileTime::UNIX_EPOCH
            })
            .unwrap(),
            r#"{"time":116444736000000000}"#
        );
        assert_eq!(
            serde_json::to_string(&Test {
                time: FileTime::MAX
            })
            .unwrap(),
            r#"{"time":18446744073709551615}"#
        );
    }

    #[cfg(feature = "std")]
    #[proptest]
    fn serialize_json_roundtrip(raw: u64) {
        let ft = Test {
            time: FileTime::new(raw),
        };
        let json = serde_json::to_string(&ft).unwrap();
        prop_assert_eq!(json, format!(r#"{{"time":{raw}}}"#));
    }

    #[test]
    fn serialize_optional_json() {
        assert_eq!(
            serde_json::to_string(&TestOption {
                time: Some(FileTime::NT_TIME_EPOCH)
            })
            .unwrap(),
            r#"{"time":0}"#
        );
        assert_eq!(
            serde_json::to_string(&TestOption {
                time: Some(FileTime::UNIX_EPOCH)
            })
            .unwrap(),
            r#"{"time":116444736000000000}"#
        );
        assert_eq!(
            serde_json::to_string(&TestOption {
                time: Some(FileTime::MAX)
            })
            .unwrap(),
            r#"{"time":18446744073709551615}"#
        );
        assert_eq!(
            serde_json::to_string(&TestOption { time: None }).unwrap(),
            r#"{"time":null}"#
        );
    }

    #[cfg(feature = "std")]
    #[proptest]
    fn serialize_optional_json_roundtrip(raw: Option<u64>) {
        let ft = TestOption {
            time: raw.map(FileTime::new),
        };
        let json = serde_json::to_string(&ft).unwrap();
        if let Some(r) = raw {
            prop_assert_eq!(json, format!(r#"{{"time":{r}}}"#));
        } else {
            prop_assert_eq!(json, r#"{"time":null}"#);
        }
    }

    #[test]
    fn deserialize_json() {
        assert_eq!(
            serde_json::from_str::<Test>(r#"{"time":0}"#).unwrap(),
            Test {
                time: FileTime::NT_TIME_EPOCH
            }
        );
        assert_eq!(
            serde_json::from_str::<Test>(r#"{"time":116444736000000000}"#).unwrap(),
            Test {
                time: FileTime::UNIX_EPOCH
            }
        );
        assert_eq!(
            serde_json::from_str::<Test>(r#"{"time":18446744073709551615}"#).unwrap(),
            Test {
                time: FileTime::MAX
            }
        );
    }

    #[cfg(feature = "std")]
    #[proptest]
    fn deserialize_json_roundtrip(raw: u64) {
        let json = format!(r#"{{"time":{raw}}}"#);
        let ft = serde_json::from_str::<Test>(&json).unwrap();
        prop_assert_eq!(ft.time, FileTime::new(raw));
    }

    #[test]
    fn deserialize_optional_json() {
        assert_eq!(
            serde_json::from_str::<TestOption>(r#"{"time":0}"#).unwrap(),
            TestOption {
                time: Some(FileTime::NT_TIME_EPOCH)
            }
        );
        assert_eq!(
            serde_json::from_str::<TestOption>(r#"{"time":116444736000000000}"#).unwrap(),
            TestOption {
                time: Some(FileTime::UNIX_EPOCH)
            }
        );
        assert_eq!(
            serde_json::from_str::<TestOption>(r#"{"time":18446744073709551615}"#).unwrap(),
            TestOption {
                time: Some(FileTime::MAX)
            }
        );
        assert_eq!(
            serde_json::from_str::<TestOption>(r#"{"time":null}"#).unwrap(),
            TestOption { time: None }
        );
    }

    #[cfg(feature = "std")]
    #[proptest]
    fn deserialize_optional_json_roundtrip(raw: Option<u64>) {
        let json = if let Some(r) = raw {
            format!(r#"{{"time":{r}}}"#)
        } else {
            String::from(r#"{"time":null}"#)
        };
        let ft = serde_json::from_str::<TestOption>(&json).unwrap();
        prop_assert_eq!(ft.time, raw.map(FileTime::new));
    }
}