deep_time/
lib.rs

1#![cfg_attr(test, allow(clippy::unwrap_used))]
2#![cfg_attr(test, allow(clippy::expect_used))]
3#![cfg_attr(not(feature = "std"), no_std)]
4
5#[cfg(feature = "alloc")]
6extern crate alloc;
7#[cfg(feature = "std")]
8extern crate std;
9
10// ──────────────────────────────────────────────────────────────
11// Optional panic handler (opt-in via feature)
12// ──────────────────────────────────────────────────────────────
13#[cfg(all(feature = "panic-handler", not(feature = "std"), not(test)))]
14use core::panic::PanicInfo;
15
16#[cfg(all(feature = "panic-handler", not(feature = "std"), not(test)))]
17#[panic_handler]
18fn panic(_info: &PanicInfo) -> ! {
19    // Uses spin_loop() for better power characteristics than plain loop{}
20    loop {
21        core::hint::spin_loop();
22    }
23}
24
25// maybe one day upgrade to f128 ¯\_(ツ)_/¯
26pub type Real = f64;
27
28#[macro_export]
29macro_rules! f {
30    ($x:expr) => {
31        $x as $crate::Real
32    };
33}
34
35/// Safe Euclidean division.
36/// Returns `default` if `rhs == 0` or if `lhs == i128::MIN && rhs == -1`.
37macro_rules! safe_div_euc {
38    ($lhs:expr, $rhs:expr, $default:expr) => {{
39        match ($lhs).checked_div_euclid($rhs) {
40            Some(q) => q,
41            None => $default,
42        }
43    }};
44}
45
46/// Safe Euclidean remainder.
47/// Returns `$default` if `rhs == 0` or if `lhs == Self::MIN && rhs == -1`.
48macro_rules! safe_rem_euc {
49    ($lhs:expr, $rhs:expr, $default:expr) => {{
50        match ($lhs).checked_rem_euclid($rhs) {
51            Some(r) => r,
52            None => $default,
53        }
54    }};
55}
56
57#[inline(always)]
58pub const fn to_sec_f(attos: u128) -> Real {
59    f!(attos) / ATTOS_PER_SECF
60}
61
62/// Converts attoseconds → seconds (s)
63#[inline(always)]
64pub fn to_sec(attos: i128) -> i128 {
65    attos / ATTOS_PER_SEC_I128
66}
67
68/// Converts attoseconds → milliseconds (ms)
69#[inline(always)]
70pub fn to_ms(attos: i128) -> i128 {
71    attos / ATTOS_PER_MS_I128
72}
73
74/// Converts attoseconds → microseconds (us)
75#[inline(always)]
76pub fn to_us(attos: i128) -> i128 {
77    attos / ATTOS_PER_US_I128
78}
79
80/// Converts attoseconds → nanoseconds (ns)
81#[inline(always)]
82pub fn to_ns(attos: i128) -> i128 {
83    attos / ATTOS_PER_NS_I128
84}
85
86/// Converts attoseconds → picoseconds (ps)
87#[inline(always)]
88pub fn to_ps(attos: i128) -> i128 {
89    attos / ATTOS_PER_PS_I128
90}
91
92/// Converts attoseconds → femtoseconds (fs)
93#[inline(always)]
94pub fn to_fs(attos: i128) -> i128 {
95    attos / ATTOS_PER_FS_I128
96}
97
98// _________________________________________
99// FEATURE MOD
100// _________________________________________
101#[cfg(feature = "parse")]
102mod alloc_parse;
103
104#[cfg(feature = "sidereal")]
105pub mod sidereal;
106
107// _________________________________________
108// MOD
109// _________________________________________
110mod an_err;
111mod ascii_str;
112mod clock_model;
113mod drift;
114mod dt;
115mod gregorian_time;
116mod light_time;
117mod parser;
118mod position;
119mod scale;
120mod time_parts;
121mod time_range;
122
123// _________________________________________
124// PUB MOD
125// _________________________________________
126pub mod constants;
127pub mod error;
128pub mod historical_sofa;
129pub mod leap_seconds;
130pub mod math;
131pub mod tzdb;
132
133// _________________________________________
134// FEATURE PUB MOD
135// _________________________________________
136#[cfg(feature = "bop")]
137pub mod bop;
138
139// _________________________________________
140// FEATURE CRATE USE
141// _________________________________________
142#[cfg(feature = "parse")]
143pub(crate) use alloc_parse::{
144    alloc_constants::*, date::*, date_classification::*, duration::*, lang_data::*, lang_map::*,
145    languages::en::*, parse_date::*, types::*,
146};
147
148// _________________________________________
149// CRATE USE
150// _________________________________________
151pub(crate) use constants::*;
152
153// _________________________________________
154// FEATURE PUB USE
155// _________________________________________
156#[cfg(feature = "parse")]
157pub use alloc_parse::types::{DateOrder, DateParseMode, Lang, ParseCfg};
158
159#[cfg(feature = "wire")]
160pub use an_err::{WireErr, WireLocation};
161
162#[cfg(feature = "sidereal")]
163pub use sidereal::Sidereal;
164
165// _________________________________________
166// PUB USE
167// _________________________________________
168pub use an_err::AnErr;
169pub use ascii_str::{AsciiStr, AsciiStrError};
170pub use clock_model::ClockModel;
171pub use drift::{Drift, Spacetime};
172pub use dt::Dt;
173pub use dt::numbers_traits::{AttosTraits, TimeTraits};
174pub use error::{DtErr, DtErrKind};
175pub use gregorian_time::{GregorianTime, YmdHms};
176pub use light_time::ObserverState;
177pub use math::{
178    atan::atan,
179    atan2::atan2,
180    cos::cos,
181    floor::floor_f,
182    log::log,
183    sin::sin,
184    sqrt::{hypot, sqrt},
185    tan::tan,
186};
187pub use position::{Position, Velocity};
188pub use scale::Scale;
189pub use time_parts::{Meridiem, Offset, TimeParts, Weekday};
190pub use time_range::{Every, TimeRange};
deep_time/lib.rs

deep_time/
lib.rs
