kine-core 0.1.1

Correct and human-readable time handling for Rust
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

use crate::leap_seconds::{BuiltinIers, BuiltinIersSigil};

cfg_if::cfg_if! {
    if #[cfg(doc)] {
        /// Time zone the `std::time::SystemTime` clock is in
        ///
        /// If this is not set properly, then all `Time`s (and dependent calculations) will
        /// be off.
        ///
        /// Usually, `SystemTime` returns POSIX timestamps, so this should be an IERS leap
        /// seconds timezone. Which one you choose depends on until which date you want time
        /// calculations to be precise.
        ///
        /// Stability note: The real type of is currently exposed only because
        /// type_alias_impl_trait is still unstable. IT WILL BE TURNED INTO
        /// `impl ~const Default + Clone + Copy + TimeZone` IN A MINOR RELEASE!
        /// And once extern existential types get done and stable, the various feature flags
        /// will be replaced with making this existential type extern (but will be kept there
        /// for backwards compatibility until the next major release)
        pub type System = BuiltinIers;

        /// Sigil for the system timezone provider, convenience
        ///
        /// Stability note: See System.
        pub type SystemSigil = BuiltinIersSigil;

    } else if #[cfg(feature = "tz-system-provider-builtin-iers")] {
        pub type System = BuiltinIers;
        pub type SystemSigil = BuiltinIersSigil;
    } else {
        compile_error!("Please define (exactly) one system timezone provider feature (tz-system-provider-*)");
    }
}

/// Time zone for the system clock
///
/// If this is not set properly then all `Time`s (and dependent calculations) will be off
///
/// Stability note: See the stability note of `System`. This line will also need to
/// change once it's possible to encode the fact that `default()` needs to be `const`, but
/// the things you can do with it will mostly change when `System` will change.
pub static SYSTEM: System = System::const_default();
pub static SYSTEM_SIGIL: SystemSigil = SystemSigil::const_default();

cfg_if::cfg_if! {
    if #[cfg(doc)] {
        /// Leap seconds provider for UTC
        ///
        /// If this is not set properly, then all `Time`s (and dependent calculations) will
        /// be off. Which one you choose depends on until which date you want time
        /// calculations to be precise.
        ///
        /// Stability note: The real type of is currently exposed only because
        /// type_alias_impl_trait is still unstable. IT WILL BE TURNED INTO
        /// `impl ~const Default + Clone + Copy + TimeZone` IN A MINOR RELEASE!
        /// And once extern existential types get done and stable, the various feature flags
        /// will be replaced with making this existential type extern (but will be kept there
        /// for backwards compatibility until the next major release)
        pub type Utc = BuiltinIers;

        /// Sigil for UTC leap seconds provider, as a convenience
        ///
        /// Stability note: See Utc.
        pub type UtcSigil = BuiltinIersSigil;

    } else if #[cfg(feature = "tz-utc-provider-builtin-iers")] {
        pub type Utc = BuiltinIers;
        pub type UtcSigil = BuiltinIersSigil;
    } else {
        compile_error!("Please define (exactly) one UTC leap seconds provider feature (tz-utc-provider-*)");
    }
}

/// Leap seconds provider for UTC
///
/// If this is not set properly then all `Time`s (and dependent calculations) will be off
///
/// Stability note: See the stability note of `Utc`. This line will also need to
/// change once it's possible to encode the fact that `default()` needs to be `const`, but
/// the things you can do with it will mostly change when `Utc` will change.
pub static UTC: Utc = Utc::const_default();
pub static UTC_SIGIL: UtcSigil = UtcSigil::const_default();