package orsetto
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=6e6f59fc6a2c590b1b377e40f2120a548e6f09e61e7eb12ffa45cf2d517316b8
md5=533153cd4a9fe8093d3b98afc1073bc8
doc/orsetto.cf/Cf_stdtime/index.html
Module Cf_stdtime
Conversions between Standard Time, UTC and TAI.
Overview
This module contains a type for representing values of standard time, defined as a reference from Coordinated Universal Time (UTC). It also provides functions for converting values of standard time to and from TAI64 values (see Cf_tai64).
Note: no facility is yet provided here for manipulating time with associated timezone attributes. Converting arbitrary values of UTC time to and from local time is tricky, since daylight savings time rules vary greatly from locality to locality, and some are even subject to change without advance notice.
Types
class type unqualified = object ... endThe class type inhabited by object types representing unqualified local time stamps, which comprise a Gregorian calendar date and a civil time synchronized with Coordinated Universal Time (UTC) without localizing time zone offset.
class type epoch = object ... endThe class type inhabited by object types representing time stamps qualified with an integral offset from local time to UTC in minutes.
The private type inhabited by time stamps in UTC, i.e. with an explicit offset of +00:00.
The private type inhabited by time stamps qualified with a local timezone offset.
Functions
val create :
date:Cf_gregorian.date ->
time:Cf_clockface.time ->
offset:int ->
localUse create ~date ~time ~offset to create a time stamp comprising ~date, ~time and ~offset.
Use localize t to convert the UTC time stamp t to a local time stamp. If ~offset is used, then the civil time and calendar date are adjusted accordingly. Raises Invalid_argument if the adjustment to the calendar date would overflow the 64-bit integer representation of the astronomical year.
Use local_to_utc to convert t to the UTC. Raises Invalid_argument in the untypical case that time zone adjustment results in an overflow in the 64-bit integer arithetic for the Gregorian calendar year.
Conversions to RFC 3394 Internet Timestamp
val local_to_inet : local -> stringUse local_to_inet t to make a string representation of t in the Internet Timestamp format, c.f RFC 3339.
val inet_to_local : string -> localUse inet_to_local s to make a timestamp with the value extracted from s according to the Internet Timestamp format.
Conversions to and from TAI64
val of_tai64 : Cf_tai64.t -> utcUse of_tai64 t to create the UTC time stamp corresponding to t.
val in_tai64_range : utc -> boolUsing in_tai64_range t returns true if t is within the range of valid TAI64 epochs (see Cf_tai64).
val to_tai64 : utc -> Cf_tai64.tUse to_tai64 t to create the TAI64 value corresponding to t. Raises Invalid_argument if t is outside the range of valid TAI64 values.