package core_unix
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=486d0e954603960fa081b3fd23e3cc3e50ac0892544acd35f9c2919c4bf5f67b
doc/core_unix.time_unix/Time_unix/index.html
Module Time_unixSource
module Time := Core.Timeinclude Core.Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Sexplib0.Sexpable.S with type t := t
include Typerep_lib.Typerepable.S with type t := t
include module type of Time
with type t := t
and module Zone := Time.Zone
and module Ofday := Time.Ofday
and module Span := Time.Span
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Base.Comparable.Polymorphic_compare with type t := t
include Core.Interfaces.Robustly_comparable with type t := t
include Core.Comparable.S_common
with type t := t
and module Replace_polymorphic_compare := Replace_polymorphic_compare
include Base.Comparable.S with type t := t
Equivalent to a Date.t and an Ofday.t with no time zone. A Date_and_ofday.t does not correspond to a single, unambiguous point in time.
val next_multiple :
?can_equal_after:Base.Bool.t ->
base:t ->
after:t ->
interval:Base.Float.t ->
Base.Unit.t ->
tnext_multiple ~base ~after ~interval returns the smallest time of the form:
time = base + k * intervalwhere k >= 0 and time > after. It is an error if interval <= 0.
Supplying ~can_equal_after:true allows the result to satisfy time >= after.
val prev_multiple :
?can_equal_before:Base.Bool.t ->
base:t ->
before:t ->
interval:Base.Float.t ->
Base.Unit.t ->
tprev_multiple ~base ~before ~interval returns the largest time of the form:
time = base + k * intervalwhere k >= 0 and time < before. It is an error if interval <= 0.
Supplying ~can_equal_before:true allows the result to satisfy time <= before.
now () returns a t representing the current time
Basic operations on times
add t s adds the span s to time t and returns the resulting time.
NOTE: adding spans as a means of adding days is not accurate, and may run into trouble due to shifts in daylight savings time, float arithmetic issues, and leap seconds. See the comment at the top of Zone.mli for a more complete discussion of some of the issues of time-keeping. For spans that cross date boundaries, use date functions instead.
sub t s subtracts the span s from time t and returns the resulting time. See important note for add.
diff t1 t2 returns time t1 minus time t2.
abs_diff t1 t2 returns the absolute span of time t1 minus time t2.
include Core.Quickcheck.S_range with type t := t
gen_incl lower_bound upper_bound produces values between lower_bound and upper_bound, inclusive. It uses an ad hoc distribution that stresses boundary conditions more often than a uniform distribution, while still able to produce any value in the range. Raises if lower_bound > upper_bound.
gen_uniform_incl lower_bound upper_bound produces a generator for values uniformly distributed between lower_bound and upper_bound, inclusive. Raises if lower_bound > upper_bound.
Comparisons
Conversions
val of_date_ofday_precise :
Core__.Date0.t ->
Base.Float.t ->
zone:Core__.Zone.t ->
[ `Once of t | `Twice of t * t | `Never of t ]Because timezone offsets change throughout the year (clocks go forward or back) some local times can occur twice or not at all. In the case that they occur twice, this function gives `Twice with both occurrences in order; if they do not occur at all, this function gives `Never with the time at which the local clock skips over the desired time of day.
Note that this is really only intended to work with DST transitions and not unusual or dramatic changes, like the calendar change in 1752 (run "cal 9 1752" in a shell to see). In particular it makes the assumption that midnight of each day is unambiguous.
Most callers should use of_date_ofday rather than this function. In the `Twice and `Never cases, of_date_ofday will return reasonable times for most uses.
val to_date_ofday_precise :
t ->
zone:Core__.Zone.t ->
Core__.Date0.t
* Base.Float.t
* [ `Only | `Also_at of t | `Also_skipped of Core__.Date0.t * Base.Float.t ]Always returns the Date.t * Ofday.t that to_date_ofday would have returned, and in addition returns a variant indicating whether the time is associated with a time zone transition.
- `Only -> there is a one-to-one mapping between [t]'s and
[Date.t * Ofday.t] pairs
- `Also_at -> there is another [t] that maps to the same [Date.t * Ofday.t]
(this date/time pair happened twice because the clock fell back)
- `Also_skipped -> there is another [Date.t * Ofday.t] pair that never happened (due
to a jump forward) that [of_date_ofday] would map to the same
[t].For performance testing only; reset_date_cache () resets an internal cache used to speed up to_date and related functions when called repeatedly on times that fall within the same day.
Unlike Time_ns, this module purposely omits max_value and min_value: 1. They produce unintuitive corner cases because most people's mental models of time do not include +/- infinity as concrete values 2. In practice, when people ask for these values, it is for questionable uses, e.g., as null values to use in place of explicit options.
val convert :
from_tz:Core__.Zone.t ->
to_tz:Core__.Zone.t ->
Core__.Date0.t ->
Base.Float.t ->
Core__.Date0.t * Base.Float.tIt's unspecified what happens if the given date/ofday/zone correspond to more than one date/ofday pair in the other zone.
Other string conversions
The {to,of}_string functions in Time convert to UTC time, because a local time zone is not necessarily available. They are generous in what they will read in.
include Base.Stringable.S with type t := t
to_filename_string t ~zone converts t to string with format YYYY-MM-DD_HH-MM-SS.mmm which is suitable for using in filenames.
of_filename_string s ~zone converts s that has format YYYY-MM-DD_HH-MM-SS.mmm into time.
to_string_abs ~zone t is the same as to_string t except that it uses the given time zone.
to_string_abs_trimmed is the same as to_string_abs, but drops trailing seconds and milliseconds if they are 0.
Same as to_string_abs_trimmed, except it leaves off the timezone, so won't reliably round trip.
Same as to_string_abs, but without milliseconds and the timezone
Same as to_sec_string but includes timezone
of_localized_string ~zone str read in the given string assuming that it represents a time in zone and return the appropriate Time.t
to_string_iso8601_basic return a string representation of the following form: %Y-%m-%dT%H:%M:%S.%s%Z e.g. to_string_iso8601_basic ~zone:Time.Zone.utc epoch = "1970-01-01T00:00:00.000000Z"
val occurrence :
[ `First_after_or_at | `Last_before_or_at ] ->
t ->
ofday:Base.Float.t ->
zone:Core__.Zone.t ->
toccurrence side time ~ofday ~zone returns a Time.t that is the occurrence of ofday (in the given zone) that is the latest occurrence (<=) time or the earliest occurrence (>=) time, according to side.
NOTE: If the given time converted to wall clock time in the given zone is equal to ofday then the t returned will be equal to the t given.
of_string_with_utc_offset requires its input to have an explicit UTC offset, e.g. 2000-01-01 12:34:56.789012-23, or use the UTC zone, "Z", e.g. 2000-01-01 12:34:56.789012Z.
to_string_utc generates a time string with the UTC zone, "Z", e.g. 2000-01-01 12:34:56.789012Z.
String conversions use the local timezone by default. Sexp conversions use get_sexp_zone () by default, which can be overridden by calling set_sexp_zone. These default time zones are used when writing a time, and when reading a time with no explicit zone or UTC offset.
Sexps and strings display the date, ofday, and UTC offset of t relative to the appropriate time zone.
include Core.Identifiable.S
with type t := t
and type comparator_witness := comparator_witness
and module Replace_polymorphic_compare := Replace_polymorphic_compare
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.
include Ppx_hash_lib.Hashable.S with type t := t
include Sexplib0.Sexpable.S with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Base.Pretty_printer.S with type t := t
val pp : Base__.Formatter.t -> t -> unitinclude Core.Comparable.S_binable
with type t := t
with type comparator_witness := comparator_witness
with module Replace_polymorphic_compare := Replace_polymorphic_compare
include Base.Comparable.S
with type t := t
with type comparator_witness := comparator_witness
compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.
ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.
clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.
Raises if not (min <= max).
val comparator : (t, comparator_witness) Base__.Comparator.comparatormodule Map :
Core.Map.S_binable
with type Key.t = t
with type Key.comparator_witness = comparator_witnessmodule Set :
Core.Set.S_binable
with type Elt.t = t
with type Elt.comparator_witness = comparator_witnessof_tm converts a Unix.tm (mirroring a struct tm from the C stdlib) into a Time.t. Note that the tm_wday, tm_yday, and tm_isdst fields are ignored.
Conversion functions that involved Ofday.Zoned.t, exactly analogous to the conversion functions that involve Ofday.t
This is like of_string except that if the string doesn't specify the zone then it raises rather than assume the local timezone.
val of_string_gen :
if_no_timezone:[ `Fail | `Local | `Use_this_one of Zone.t ] ->
string ->
tof_string_gen ~if_no_timezone s attempts to parse s to a t. If s doesn't supply a time zone if_no_timezone is consulted.
t_of_sexp_abs sexp as t_of_sexp, but demands that sexp indicate the timezone the time is expressed in.
Miscellaneous
interruptible_pause span sleeps for span time unless interrupted (e.g. by delivery of a signal), in which case the remaining unslept portion of time is returned.
pause_forever sleeps indefinitely.
format t fmt formats the given time according to fmt, which follows the formatting rules given in 'man strftime'. The time is output in the given timezone. Here are some commonly used control codes:
%Y - year (4 digits) %y - year (2 digits) %m - month %d - day %H - hour %M - minute %S - second
a common choice would be: %Y-%m-%d %H:%M:%S
Although %Z and %z are interpreted as format strings, neither are correct in the current implementation. %Z always refers to the local machine timezone, and does not correctly detect whether DST is active. The effective local timezone can be controlled by setting the "TZ" environment variable before calling format. %z behaves unreliably and should be avoided.
Not all strftime control codes are standard; the supported subset will depend on the C libraries linked into a given executable.
parse string ~fmt ~zone parses string, according to fmt, which follows the formatting rules given in 'man strptime'. The time is assumed to be in the given timezone.
%Y - year (4 digits) %y - year (2 digits) %m - month %d - day %H - hour %M - minute %S - second
Raise if allow_trailing_input is false and fmt does not consume all of the input.