lox-time 0.1.0-alpha.27

Time modelling tools for the Lox 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

// SPDX-FileCopyrightText: 2023 Andrei Zisu <matzipan@gmail.com>
// SPDX-FileCopyrightText: 2023 Angus Morrison <github@angus-morrison.com>
// SPDX-FileCopyrightText: 2023 Helge Eichhorn <git@helgeeichhorn.de>
//
// SPDX-License-Identifier: MPL-2.0

/*!
    `lox-time` defines an API for working with instants in astronomical time scales.

    # Overview

    `lox_time` exposes:
    - the marker trait [ContinuousTimeScale](time_scales::ContinuousTimeScale) and zero-sized implementations
      representing the most common, continuous astronomical time scales;
    - the concrete type [Time] representing an instant in a [ContinuousTimeScale](time_scales::ContinuousTimeScale);
    - [Utc](utc::Utc), the only discontinuous time representation supported by Lox;
    - the [`TryOffset`](offsets::TryOffset) and [`Offset`](offsets::Offset) traits, supporting
      transformations between pairs of time scales;
    - standard implementations of the most common time scale transformations.

    # Continuous vs discontinuous timescales

    Internally, Lox uses only continuous time scales (i.e. time scales without leap seconds). An
    instance of [Time] represents an instant in time generic over a continuous
    [ContinuousTimeScale](time_scales::ContinuousTimeScale).

    [Utc](utc::Utc) is used strictly as an I/O time format, which must be transformed into a continuous time
    scale before use in the wider Lox ecosystem.

    This separation minimises the complexity in working with leap seconds, confining these
    transformations to the crate boundaries.
*/

#![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)]

extern crate alloc;

/// Calendar date types (re-exported from `lox-core`).
pub mod calendar_dates;
/// Conversions between `lox-time` and `chrono` types.
#[cfg(feature = "chrono")]
pub mod chrono;
/// Time deltas (re-exported from `lox-core`).
pub mod deltas;
/// Time intervals and set operations on them.
pub mod intervals;
/// Julian date types (re-exported from `lox-core`).
pub mod julian_dates;
/// Time scale offset computation.
pub mod offsets;
/// Time-indexed interpolation series.
pub mod series;
/// Sub-second precision types (re-exported from `lox-core`).
pub mod subsecond;
/// The [`Time`] type representing an instant in a continuous time scale.
pub mod time;
/// Time-of-day types (re-exported from `lox-core`).
pub mod time_of_day;
/// Astronomical time scale definitions.
pub mod time_scales;
/// Coordinated Universal Time (UTC) with leap-second support.
pub mod utc;

pub use time::{Time, TimeBuilder, TimeError, TimeScaleMismatch};