package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

Time module.

module Span : sig ... end
module Ofday : sig ... end
type t = private Int63.t
val hash_fold_t : Ppx_hash_lib.Std.Hash.state -> t -> Ppx_hash_lib.Std.Hash.state
val hash : t -> Ppx_hash_lib.Std.Hash.hash_value
include Typerep_lib.Typerepable.S with type t := t
val typerep_of_t : t Typerep_lib.Std_internal.Typerep.t
val typename_of_t : t Typerep_lib.Typename.t
include Bin_prot.Binable.S with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader
val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_t : t Bin_prot.Type_class.t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
module Alternate_sexp : sig ... end

Note that we expose a sexp format that is not the one exposed in Core.

Conversions
val of_date_ofday : zone:Core_kernel__.Zone.t -> Core_kernel__.Date0.t -> Ofday.t -> t
val of_date_ofday_precise : Core_kernel__.Date0.t -> 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.

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

val convert : from_tz:Core_kernel__.Zone.t -> to_tz:Core_kernel__.Zone.t -> Core_kernel__.Date0.t -> Ofday.t -> Core_kernel__.Date0.t * 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.

val utc_offset : t -> zone:Core_kernel__.Zone.t -> 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.

val of_string : string -> t
val to_string : t -> string
val 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.

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

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

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

val to_string_abs_parts : t -> zone:Core_kernel__.Zone.t -> Base.String.t Base.List.t
val 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.

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

Same as to_string_abs, but without milliseconds

val 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

val of_string_gen : default_zone:(Base.Unit.t -> Core_kernel__.Zone.t) -> find_zone:(Base.String.t -> Core_kernel__.Zone.t) -> Base.String.t -> t

of_string_gen ~default_zone ~find_zone s attempts to parse s as a t, calling out to default_zone and find_zone as needed.

val 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"

val occurrence : [ `First_after_or_at | `Last_before_or_at ] -> t -> ofday: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.

val epoch : t

Unix epoch (1970-01-01 00:00:00 UTC)

val min_value : t
val max_value : t
val now : Base.Unit.t -> t
val add : t -> Span.t -> t

overflows silently

val sub : t -> Span.t -> t

overflows silently

val next : t -> t

overflows silently

val prev : t -> t

overflows silently

val diff : t -> t -> Span.t

overflows silently

val abs_diff : t -> t -> Span.t

overflows silently

val to_span_since_epoch : t -> Span.t
val of_span_since_epoch : Span.t -> t
val to_int63_ns_since_epoch : t -> Int63.t
val of_int63_ns_since_epoch : Int63.t -> t
val to_int_ns_since_epoch : t -> Base.Int.t

Will raise on 32-bit platforms. Consider to_int63_ns_since_epoch instead.

val of_int_ns_since_epoch : Base.Int.t -> t
val next_multiple : ?can_equal_after:Base.Bool.t -> base:t -> after:t -> interval: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.

Overflows silently.

val prev_multiple : ?can_equal_before:Base.Bool.t -> base:t -> before:t -> interval: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.

val random : ?state:Core_kernel__.Import.Random.State.t -> Base.Unit.t -> t
val of_time : Base.Float.t -> t
  • deprecated [since 2019-01] use [of_time_float_round_nearest] or [of_time_float_round_nearest_microsecond]
val to_time : t -> Base.Float.t
  • deprecated [since 2019-01] use [to_time_float_round_nearest] or [to_time_float_round_nearest_microsecond]
val to_time_float_round_nearest : t -> Base.Float.t
val to_time_float_round_nearest_microsecond : t -> Base.Float.t
val of_time_float_round_nearest : Base.Float.t -> t
val of_time_float_round_nearest_microsecond : Base.Float.t -> t
module Utc : sig ... end
module 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