tick 0.3.3

Provides primitives to interact with and manipulate machine time.
Documentation 
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

use std::time::SystemTime;

/// Extension trait for [`SystemTime`] that provides formatting capabilities.
pub trait SystemTimeExt: sealed::Sealed {
    /// Returns a value that formats the [`SystemTime`] in ISO 8601 format.
    ///
    /// Times outside the valid range (before year -9999 or after year 9999) are saturated
    /// to the nearest boundary.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::time::{Duration, SystemTime};
    ///
    /// use tick::SystemTimeExt;
    ///
    /// let time = SystemTime::UNIX_EPOCH + Duration::from_hours(1);
    /// assert_eq!(time.display_iso_8601().to_string(), "1970-01-01T01:00:00Z");
    /// ```
    #[cfg(any(feature = "fmt", test))]
    fn display_iso_8601(&self) -> impl std::fmt::Display;
}

impl SystemTimeExt for SystemTime {
    #[cfg(any(feature = "fmt", test))]
    fn display_iso_8601(&self) -> impl std::fmt::Display {
        // jiff's Timestamp implements Display that outputs ISO 8601 format
        to_timestamp(*self)
    }
}

#[cfg(any(feature = "fmt", test))]
fn to_timestamp(system_time: SystemTime) -> jiff::Timestamp {
    match jiff::Timestamp::try_from(system_time) {
        Ok(timestamp) => timestamp,
        Err(_) => to_timestamp_min_max(system_time),
    }
}

#[cfg(any(feature = "fmt", test))]
fn to_timestamp_min_max(system_time: SystemTime) -> jiff::Timestamp {
    if system_time.duration_since(SystemTime::UNIX_EPOCH).is_ok() {
        jiff::Timestamp::MAX
    } else {
        jiff::Timestamp::MIN
    }
}

mod sealed {
    pub trait Sealed {}
    impl Sealed for std::time::SystemTime {}
}

#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg(test)]
mod tests {
    use std::time::Duration;

    use jiff::Timestamp;

    use super::*;

    #[test]
    fn display_ok() {
        assert_eq!(SystemTime::UNIX_EPOCH.display_iso_8601().to_string(), "1970-01-01T00:00:00Z");

        assert_eq!(
            (SystemTime::UNIX_EPOCH + Duration::from_hours(1)).display_iso_8601().to_string(),
            "1970-01-01T01:00:00Z"
        );
    }

    #[test]
    fn display_out_of_range() {
        let time = SystemTime::from(Timestamp::MAX) + Duration::from_secs(12345);
        assert_eq!(time.display_iso_8601().to_string(), "9999-12-30T22:00:00.999999999Z");
    }

    #[test]
    fn to_timestamp_fallback_ok() {
        let now = SystemTime::UNIX_EPOCH + Duration::from_secs(12345);
        assert_eq!(to_timestamp_min_max(now), jiff::Timestamp::MAX);

        let past = SystemTime::UNIX_EPOCH - Duration::from_secs(12345);
        assert_eq!(to_timestamp_min_max(past), jiff::Timestamp::MIN);
    }
}