package core

  1. Overview
  2. Docs
On This Page
  1. Miscellaneous
package core
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Core.TimeSource

Sourcemodule Span : sig ... end
Sourcemodule Zone : sig ... end
Sourcemodule Ofday : sig ... end

A fully qualified point in time, independent of timezone.

include Core_kernel.Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
include Typerep_lib.Typerepable.S with type t := t
include module type of Core_kernel.Time with type t := t and module Zone := Core_kernel.Time.Zone and module Ofday := Core_kernel.Time.Ofday and module Span := Core_kernel.Time.Span
module type S_kernel_without_zone = Core_kernel.Time.S_kernel_without_zone
module type S_kernel = Core_kernel.Time.S_kernel
Sourcetype underlying = Base.Float.t
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
include Typerep_lib.Typerepable.S with type t := t
Sourceval typename_of_t : t Typerep_lib.Typename.t
include Core_kernel.Comparable.Polymorphic_compare with type t := t
include Base.Comparisons.Infix with type t := t
include Core_kernel.Interfaces.Robustly_comparable with type t := t
Sourceval next : t -> t

next t returns the next t (forwards in time)

Sourceval prev : t -> t

prev t returns the previous t (backwards in time)

Sourceval to_span_since_epoch : t -> Core_kernel.Time.Span.t
Sourceval of_span_since_epoch : Core_kernel.Time.Span.t -> t
include Core_kernel.Comparable.S_common with type t := t and module Replace_polymorphic_compare := Replace_polymorphic_compare
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
include Base.Comparator.S with type t := t
Sourcetype comparator_witness
Sourcemodule Date_and_ofday : sig ... end

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.

Sourceval next_multiple : ?can_equal_after:Base.Bool.t -> base:t -> after:t -> interval:Core_kernel.Time.Span.t -> Base.Unit.t -> t

next_multiple ~base ~after ~interval returns the smallest time of the form:

  time = base + k * interval

where k >= 0 and time > after. It is an error if interval <= 0.

Supplying ~can_equal_after:true allows the result to satisfy time >= after.

Sourceval prev_multiple : ?can_equal_before:Base.Bool.t -> base:t -> before:t -> interval:Core_kernel.Time.Span.t -> Base.Unit.t -> t

prev_multiple ~base ~before ~interval returns the largest time of the form:

  time = base + k * interval

where k >= 0 and time < before. It is an error if interval <= 0.

Supplying ~can_equal_before:true allows the result to satisfy time <= before.

Sourcemodule Stable : sig ... end
Sourceval now : Base.Unit.t -> t

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.

Sourceval abs_diff : t -> t -> Core_kernel.Time.Span.t

abs_diff t1 t2 returns the absolute span of time t1 minus time t2.

include Core_kernel.Quickcheck.S_range with type t := t
include Core_kernel.Quickcheck_intf.S with type t := t
Sourceval quickcheck_generator : t Base_quickcheck.Generator.t
Sourceval quickcheck_observer : t Base_quickcheck.Observer.t
Sourceval quickcheck_shrinker : t Base_quickcheck.Shrinker.t
Sourceval gen_incl : t -> t -> t Base_quickcheck.Generator.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.

Sourceval gen_uniform_incl : t -> t -> t Base_quickcheck.Generator.t

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
Sourceval is_earlier : t -> than:t -> Base.Bool.t
Sourceval is_later : t -> than:t -> Base.Bool.t
Conversions
Sourceval of_date_ofday : zone:Core_kernel__.Zone.t -> Core_kernel__.Date0.t -> Core_kernel.Time.Ofday.t -> t
Sourceval of_date_ofday_precise : Core_kernel__.Date0.t -> Core_kernel.Time.Ofday.t -> zone:Core_kernel__.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.

Sourceval to_date_ofday : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Date0.t * Core_kernel.Time.Ofday.t
Sourceval to_date_ofday_precise : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Date0.t * Core_kernel.Time.Ofday.t * [ `Only | `Also_at of t | `Also_skipped of Core_kernel__.Date0.t * Core_kernel.Time.Ofday.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].
Sourceval to_date : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Date0.t
Sourceval to_ofday : t -> zone:Core_kernel__.Zone.t -> Core_kernel.Time.Ofday.t
Sourceval reset_date_cache : Base.Unit.t -> Base.Unit.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.

Sourceval epoch : t

midnight, Jan 1, 1970 in UTC

Sourceval convert : from_tz:Core_kernel__.Zone.t -> to_tz:Core_kernel__.Zone.t -> Core_kernel__.Date0.t -> Core_kernel.Time.Ofday.t -> Core_kernel__.Date0.t * Core_kernel.Time.Ofday.t

It's unspecified what happens if the given date/ofday/zone correspond to more than one date/ofday pair in the other zone.

Sourceval utc_offset : t -> zone:Core_kernel__.Zone.t -> Core_kernel.Time.Span.t
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 Core_kernel.Interfaces.Stringable with type t := t
Sourceval to_filename_string : t -> zone:Core_kernel__.Zone.t -> Base.String.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.

Sourceval of_filename_string : Base.String.t -> zone:Core_kernel__.Zone.t -> t

of_filename_string s ~zone converts s that has format YYYY-MM-DD_HH-MM-SS.mmm into time.

Sourceval to_string_abs : t -> zone:Core_kernel__.Zone.t -> Base.String.t

to_string_abs ~zone t is the same as to_string t except that it uses the given time zone.

Sourceval to_string_abs_trimmed : t -> zone:Core_kernel__.Zone.t -> Base.String.t

to_string_abs_trimmed is the same as to_string_abs, but drops trailing seconds and milliseconds if they are 0.

Sourceval to_string_abs_parts : t -> zone:Core_kernel__.Zone.t -> Base.String.t Base.List.t
Sourceval to_string_trimmed : t -> zone:Core_kernel__.Zone.t -> Base.String.t

Same as to_string_abs_trimmed, except it leaves off the timezone, so won't reliably round trip.

Sourceval to_sec_string : t -> zone:Core_kernel__.Zone.t -> Base.String.t

Same as to_string_abs, but without milliseconds

Sourceval of_localized_string : zone:Core_kernel__.Zone.t -> Base.String.t -> t

of_localized_string ~zone str read in the given string assuming that it represents a time in zone and return the appropriate Time.t

Sourceval to_string_iso8601_basic : t -> zone:Core_kernel__.Zone.t -> Base.String.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"

Sourceval occurrence : [ `First_after_or_at | `Last_before_or_at ] -> t -> ofday:Core_kernel.Time.Ofday.t -> zone:Core_kernel__.Zone.t -> t

occurrence 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.

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_kernel.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
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

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.

Sourceval bin_shape_t : Bin_prot.Shape.t
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0__.Sexp.t -> t
include Core_kernel.Identifiable.S_common with type t := t
Sourceval sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
include Base.Stringable.S with type t := t
Sourceval of_string : string -> t
Sourceval to_string : t -> string
include Base.Pretty_printer.S with type t := t
Sourceval pp : Base.Formatter.t -> t -> unit
include Core_kernel.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
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval equal : t -> t -> bool
Sourceval compare : t -> t -> int

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.

Sourceval min : t -> t -> t
Sourceval max : t -> t -> t
Sourceval ascending : t -> t -> int

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.

Sourceval descending : t -> t -> int
Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval clamp_exn : t -> min:t -> max:t -> t

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).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t with type comparator_witness := comparator_witness
Sourceval validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
Sourceval validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
include Core_kernel.Comparator.S with type t := t with type comparator_witness := comparator_witness
include Core_kernel.Hashable.S_binable with type t := t
Sourceval hashable : t Base.Hashable.t
Sourceval get_sexp_zone : unit -> Zone.t
Sourceval set_sexp_zone : Zone.t -> unit
include Core_kernel.Robustly_comparable with type t := t
Sourceval (>=.) : t -> t -> bool
Sourceval (<=.) : t -> t -> bool
Sourceval (=.) : t -> t -> bool
Sourceval (>.) : t -> t -> bool
Sourceval (<.) : t -> t -> bool
Sourceval (<>.) : t -> t -> bool
Sourceval robustly_compare : t -> t -> int
Sourceval of_tm : Caml_unix.tm -> zone:Zone.t -> t

of_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.

Sourceval of_date_ofday_zoned : Core_kernel.Date.t -> Ofday.Zoned.t -> t

Conversion functions that involved Ofday.Zoned.t, exactly analogous to the conversion functions that involve Ofday.t

Sourceval to_date_ofday_zoned : t -> zone:Core_kernel.Time.Zone.t -> Core_kernel.Date.t * Ofday.Zoned.t
Sourceval to_ofday_zoned : t -> zone:Core_kernel.Time.Zone.t -> Ofday.Zoned.t
Sourceval to_string_fix_proto : [ `Utc | `Local ] -> t -> string
Sourceval of_string_fix_proto : [ `Utc | `Local ] -> string -> t
Sourceval of_string_abs : string -> 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.

Sourceval of_string_gen : if_no_timezone:[ `Fail | `Local | `Use_this_one of Zone.t ] -> string -> t

of_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.

Sourceval t_of_sexp_abs : Core_kernel.Sexp.t -> t

t_of_sexp_abs sexp as t_of_sexp, but demands that sexp indicate the timezone the time is expressed in.

Sourceval sexp_of_t_abs : t -> zone:Zone.t -> Core_kernel.Sexp.t
Miscellaneous
Sourceval pause : Span.t -> unit

pause span sleeps for span time.

Sourceval interruptible_pause : Span.t -> [ `Ok | `Remaining of Span.t ]

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.

Sourceval pause_forever : unit -> Core_kernel.Nothing.t

pause_forever sleeps indefinitely.

Sourceval format : t -> string -> zone:Zone.t -> string

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.

Sourceval parse : string -> fmt:string -> zone:Zone.t -> t

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
Sourcemodule Exposed_for_tests : sig ... end
Sourcemodule Stable : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct