scsys-time 0.3.2

temporal abstractions, primitives, and utilities for the scsys ecosystem
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

/*
    Appellation: scsys-time <library>
    Created At: 2025.09.08:18:11:37
    Contrib: @FL03
*/
//! The [`time`](self) module focuses on implementing various time-related features and utilities.
//! It provides a generic [`Timestamp`] along with supporting traits and types to facilitate
//! time management.
//!
//! Additionally, the crate defines several key traits to support time functionalities:
//!
//! - [`RawTimestamp`] - A marker trait denoting compatible raw timestamp types
//! - [`Now`] - A trait for obtaining the current time
//!
#![allow(
    non_snake_case,
    clippy::module_inception,
    clippy::missing_safety_doc,
    clippy::needless_doctest_main,
    clippy::upper_case_acronyms
)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(all(feature = "alloc", feature = "nightly"), feature(allocator_api))]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/scattered-systems/.github/main/assets/logo.png",
    html_favicon_url = "https://raw.githubusercontent.com/scattered-systems/.github/main/assets/favicon.ico"
)]

#[cfg(feature = "alloc")]
extern crate alloc;

#[cfg(not(any(feature = "alloc", feature = "std")))]
compile_error!(
    "Either feature \"alloc\" or feature \"std\" must be enabled for the `time` crate to compile."
);

#[doc(inline)]
pub use self::{
    epoch::Epoch,
    error::{Error, Result},
    timestamp::Timestamp,
    traits::*,
};

#[doc(inline)]
#[cfg(feature = "std")]
pub use self::utils::*;

pub mod epoch;
pub mod error;
pub mod timestamp;

#[doc(hidden)]
pub mod datetime;

#[macro_use]
pub(crate) mod macros {
    #[macro_use]
    pub mod seal;
}

pub mod traits {
    //! this moodule implements the core traits supporting the `time` module
    #[doc(inline)]
    pub use self::prelude::*;

    mod now;
    mod raw_timestamp;
    mod temporal;

    mod prelude {
        #[doc(inline)]
        pub use super::now::*;
        #[doc(inline)]
        pub use super::raw_timestamp::*;
        #[doc(hidden)]
        pub use super::temporal::*;
    }
}

pub mod utils {
    //! time-related utilities
    //!
    #[doc(inline)]
    #[allow(unused_imports)]
    pub use self::prelude::*;

    #[cfg(feature = "alloc")]
    mod impl_alloc;
    #[cfg(feature = "std")]
    mod impl_std;

    #[allow(unused_imports)]
    mod prelude {
        #[cfg(feature = "alloc")]
        pub use super::impl_alloc::*;
        #[cfg(feature = "std")]
        pub use super::impl_std::*;
    }
}

#[doc(hidden)]
pub mod prelude {
    pub use crate::epoch::Epoch;
    pub use crate::timestamp::Timestamp;
    pub use crate::traits::*;
    #[cfg(feature = "std")]
    pub use crate::utils::*;
}