deep-time
A fully featured and high performance Rust date and time library with attosecond precision that provides astronomical and civil timekeeping.
Overview
- Auto-parsers for datetimes and durations that handle thousands of formats, relative dates and multiple languages, requires the
parsefeature - No std, no alloc, and wide-spread const fn
- Extensively validated against outputs from Astropy, Jiff, and other libraries and sources
- Fast ISO parser
- Time scales e.g. UTC with leap seconds support, including historical, TT, TAI, TDB, NAIF ET, LTC, GPS, etc. An optional feature
tdb-hican be enabled which provides the ERFA TDB model - Strptime
- Strftime (multi-language day and month names available)
- First class timezone support provided by the Rust library jiff enabled with the
jiff-tzfeature - To and from all kinds of inputs and outputs, functions mostly prefixed with
toandfrom, available on the library's types, see the main time types functions: Dt. Including JD, MJD, Unix, NTP, etc. - Calendar aware and, with the
jiff-tzfeature, timezone aware math - To and from jiff, chrono, hifitime, time, and ICU4X types
- No-alloc string return type
- Const fn libm math functions
- Safe, saturating arithmetic throughout
- No
unsafein the library -#![forbid(unsafe_code)] - Lunar and Mars modules
- Sidereal time with a const fn implementation of ERFA Equation of the Origins / Equinoxes
- UT1 and EOP
- Proper time along trajectories — usage guide docs/trajectory.md. Requires the
physicsfeature - Relativity types: Drift, Spacetime, Position, Velocity — rate-model theory docs/relativity.md. Import via
deep_time::physics. Requires thephysicsfeature. - CCSDS CUC, CDS, and CCS
- Binary size is mainly controlled through feature gating
Examples
use ;
use ;
Documentation
Installation
- This crate has no default features.
- The minimum Rust version is
1.90and minimum Rust edition is2024. This is mainly due to someconstfunctionality that only became stable recently.
To add deep-time to your Rust project with the parse and timezone features, go to your project folder and run this terminal command:
cargo add deep-time --features "parse,jiff-tz"
Feature Flags
| Feature | Description | Requires |
|---|---|---|
parse |
Enables the auto-parsers (from_str_parse, from_str_duration, etc.) |
alloc |
jiff-tz |
Enables timezone features such as tz parsing, tz calendar math, formatting | std |
jiff-tz-bundle |
Same as jiff-tz but bundles the full timezone database |
std |
jiff |
Enables jiff interop |
— |
chrono |
Enables chrono interop |
— |
hifitime |
Enables hifitime interop |
— |
time |
Enables time interop |
— |
icu |
Enables ICU4X interop (DateTime<Iso>) |
— |
serde |
Enables Serialize / Deserialize for Dt and other types |
alloc |
js |
WebAssembly support (includes serde and JS bindings) |
std |
tsify |
TypeScript definitions via tsify (for WASM) |
js |
std |
Enables std functionality including Dt::now() and file handling |
— |
alloc |
Enables allocation (required for parsing and some conversions) | — |
es / de / fr |
Language support, parsing different languages requires alloc, formatting does not | — |
euro |
Enables all European languages | |
lang |
Enables all languages | euro |
panic-handler |
Provides an optional simple #[panic_handler] for no_std environments |
no_std |
defmt |
Enables defmt::Format |
— |
wire |
Enables wire format (serialization) support | — |
tdb-hi |
Replaces the fast TDB and TCB conversions with the full ERFA TDB model | — |
physics |
Enables relativistic physics support (Drift, Spacetime, Position, Velocity, proper-time trajectory APIs). Import via deep_time::physics. |
— |
mars |
Enables Mars time support (to_msd, to_mars_ls, etc.) |
— |
sidereal |
Enables sidereal time support | — |
eop |
Enables Earth Orientation Parameters (UT1, etc.) | alloc |
locale |
Enables system locale detection | std |
Optional No-Alloc Panic Handler
deep-time supports no_std + no_alloc environments. When targeting bare-metal or embedded systems, you can enable a minimal panic handler:
[]
= { = "0.1", = ["panic-handler"] }
This provides a simple #[panic_handler] that uses core::hint::spin_loop() (more power-efficient than a plain loop {}).
You only need this if you are building a binary crate in a no_std environment without your own panic handler.
Notes
- The fast ISO 8601 parser (
from_str_iso) works without theparsefeature. - Multi-language parsing requires the
parsefeature, but multi-language formatting works without it. - The
.parse()implementation onDtautomatically chooses between the full parser and the ISO parser depending on enabled features.
Additional Examples
| Example | What it shows | Run |
|---|---|---|
precision_control |
Compare, and format times at a chosen resolution (here: one minute) | cargo run --example precision_control |
sidereal_time |
Astropy-style GMST/GAST/LMST/LAST with UT1 from IERS finals, plus hour angle | cargo run --example sidereal_time --features "sidereal-earth eop std" |
proper_time_path |
Proper time / craft-vs-ground from (t, v, Φ) samples |
cargo run --example proper_time_path --features physics |
Performance
Benchmarks were measured on an AMD Ryzen 7 7800X3D using:
Parsing and Formatting
| deep-time vs jiff | Time | vs Jiff 0.2.31 |
|---|---|---|
Parts::from_str_iso vs DateTime::parse |
20.1 ns | 27.2% faster |
Parts::from_str vs BrokenDownTime::parse |
36.3 ns | 8.8% faster |
Dt::from_str vs BrokenDownTime::parse+to_zoned |
194 ns | 20.8% slower |
Dt::to_str_b vs DateTime::strftime+.to_string |
75.2 ns | 23.0% slower |
Dt::to_str vs DateTime::strftime+.to_string |
87.7 ns | 43.4% slower |
Dt::from_str_parse |
542 ns | — |
Time Scale Conversions
| Conversion | deep-time | hifitime 4.3 | Relative Performance |
|---|---|---|---|
| TAI → UTC | 9.6 ns | 34.7 ns | 3.6× faster |
| UTC → TAI | 13.0 ns | 33.1 ns | 2.5× faster |
| TAI → TDB | 131 ns | 93.7 ns | 1.4× slower |
| TDB → TAI | 583 ns | 27.0 ns | 21.6× slower |
| GPS conversion | 20.2 ns | 5.5 ns | 3.7× slower |
| GPS week + TOW | 30.2 ns | 7.6 ns | 4.0× slower |
Bundled Files
This library bundles some data relevant to, for example, time scale conversions. While every effort will be made to keep the library up to date, perhaps some users will want to know how to re-generate or update certain files and then re-compile.
Leap Seconds
The latest leap seconds table is bundled as a .rs file. A runtime file can be parsed and loaded for time scale conversions, e.g.
If for whatever reason you need to update the library's bundled leap seconds file and re-compile, follow these steps:
- Download the desired leap seconds file, for example from https://data.iana.org/time-zones/data/leap-seconds.list
- Place the downloaded file in the library, with the following location and filename:
deep-time/tests/assets/leap-seconds.list.txt - Then with a terminal open in the library run the command:
cargo gen-leap-seconds - This should overwrite the file
src/utc/leap_seconds_list.rsusing the data - Re-compile the library
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.