deep-time 0.1.0-beta.23

High-precision, no-std, no-alloc date-time library, leap-seconds, time scales, relativistic time, and a powerful date & duration parser
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! [`DtErrKind`] and main error type [`DtErr`].
//! [`DtErr`] is a type alias to [`AnErr`].

use crate::AnErr;

/// The kind of error returned by deep-time.
///
/// Almost every function in this crate that can fail returns a
/// [`DtErr`](type.DtErr.html). That error is made of two parts:
///
/// 1. A **kind** — one of the variants of this enum (what went wrong).
/// 2. A short **reason** string — optional extra detail (up to 15 bytes).
///
/// Those two pieces live inside [`AnErr`](struct.AnErr.html). [`DtErr`](type.DtErr.html)
/// is simply `AnErr<DtErrKind, 15>` — the whole error is 16 bytes.
///
/// Create one with the [`an_err!`](macro.an_err!.html) macro, and read the kind
/// back with [`.kind()`](struct.AnErr.html#method.kind):
///
/// ```
/// use deep_time::{DtErr, DtErrKind, an_err};
///
/// let err: DtErr = an_err!(DtErrKind::YearOutOfRange, "year={}", 10_000);
/// assert_eq!(err.kind(), DtErrKind::YearOutOfRange);
/// ```
///
/// When printed, an error looks like `YearOutOfRange` or
/// `YearOutOfRange: year=10000`.
///
/// This enum is marked `#[non_exhaustive]`, so new variants may be added in
/// later releases. Always keep a catch-all arm (`_ => ...`) when matching.
#[non_exhaustive]
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "tsify", derive(tsify::Tsify))]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum DtErrKind {
    UnexpectedEnd,
    TruncatedDirective,
    UnknownItem,
    MissingFeature,
    MissingRefTimeOrStd,
    MustStartWith,
    UnsupportedItem,
    MismatchedLiteral,
    ExpectedUnit,
    ExpectedValue,
    ExpectedYear,
    ExpectedCentury,
    ExpectedMonth,
    ExpectedDay,
    ExpectedDayOfYear,
    ExpectedHour,
    ExpectedMinute,
    ExpectedSecond,
    ExpectedFractional,
    ExpectedTimestamp,
    ExpectedWeekNumber,
    ExpectedWeekdayNumber,
    ExpectedDigits,
    ExpectedMonWeekday,
    ExpectedSunWeekday,
    ExpectedMonWeek,
    ExpectedSunWeek,
    MonWeekdayOutOfRange,
    SunWeekdayOutOfRange,
    InvalidCodeId,
    NonMonotonic,
    TFieldTooShort,
    PFieldTooShort,
    InvalidSubmillisecond,
    InvalidWeekdayName,
    InvalidMonthName,
    InvalidMeridiem,
    InvalidScale,
    InvalidDate,
    InvalidTime,
    InvalidYear,
    InvalidMonth,
    InvalidDay,
    InvalidDayOfYear,
    InvalidIsoWeekYear,
    InvalidIsoWeek,
    InvalidSunWeek,
    InvalidMonWeek,
    InvalidHour,
    InvalidMinute,
    InvalidSecond,
    InvalidFractional,
    InvalidTimestamp,
    InvalidName,
    InvalidTimeZone,
    OffsetMissingSign,
    InvalidOffsetHour,
    InvalidOffsetMinute,
    InvalidOffsetSecond,
    InvalidOffsetColons,
    InvalidOffset,
    InvalidNumber,
    InvalidItem,
    InvalidBytes,
    InvalidSyntax,
    OutOfRange,
    MonthOutOfRange,
    DayOutOfRange,
    DayOfYearOutOfRange,
    HourOutOfRange,
    MinuteOutOfRange,
    SecondOutOfRange,
    WeekOutOfRange,
    IsoWeekOutOfRange,
    YearOutOfRange,
    FracOutOfRange,
    MjdOutOfRange,
    TrailingCharacters,
    Incomplete,
    InvalidInput,
    InvalidLen,
    InternalErr,
    ConversionFail,
    IOErr,
    Empty,
}

/// Wrapper around [`AnErr`].
///
/// A [`DtErr`] object is 16 bytes.
pub type DtErr = AnErr<DtErrKind, 15>;