Debian Codegraph @

time/date/README

raw
1 date: international Gregorian chronology & calendar support
2
3 The time::date module implements the common international Gregorian chronology,
4 based on the astronomically numbered proleptic Gregorian calendar and the ISO
5 week-numbering calendar, as per the ISO 8601 standard, and the common 24 hour
6 clock. It provides [[date]], a representation of civil date/time and a optimized
7 extension of the [[time::chrono::moment]] type.
8
9 The [[time::chrono::]] module has many useful functions which interoperate with
10 dates. Any [[time::chrono::]] function which accepts *moment also accepts *date.
11
12 Dates are created using [[new]], [[now]], [[localnow]], or a "from_" function.
13 Alternatively, the [[virtual]]+[[realize]] interface can handle indeterminate
14 date/time information, and construct new dates incrementally and safely.
15
16 The observer functions ([[year]], [[hour]], etc.) evaluate a date's observed
17 chronological values, adjusted for its associated [[locality]]. Use [[in]] to
18 localize a date to another locality. Consult your system's timezone database
19 using [[tzdb]].
20
21 For working with date/time strings, see [[parse]] and [[format]].
22
23 Date arithmetic is categorized into two:
24
25 - Timescalar, using [[time::duration]]: See [[add]], [[time::chrono::diff]].
26 - Chronological, using [[span]], [[step]]: See [[reckon]], [[traverse]], [[hop]],
27 [[truncate]].
28
29 Chronologies are irregular due to field overflows and timezone discontinuities.
30 These effects are mitigated with [[zflag]] and [[rflag]], which deserve careful
31 consideration.