Module type Core_time.S
module Time : Core__.Import.Time.S_kernel with module Time := Time0
module Span : sig ... end
module Zone : sig ... end
module Ofday : sig ... end
type t
= Time.t
A fully qualified point in time, independent of timezone.
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions 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
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 variantt
afterwards.
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 compare : t -> t -> int
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
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 module type of Time with type Time.t := t and module Time.Zone := Time.Zone and module Time.Ofday := Time.Ofday and module Time.Span := Time.Span
include Core_kernel__.Time_intf.Basic
module Time : Core_kernel__.Time0_intf.S
include module type of sig ... end
type underlying
= Time.underlying
type t
= Time.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 hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val typerep_of_t : t Typerep_lib.Std_internal.Typerep.t
val typename_of_t : t Typerep_lib.Typename.t
module Span = Time.Span
module Ofday = Time.Ofday
module Replace_polymorphic_compare = Time.Replace_polymorphic_compare
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 robustly_compare : t -> t -> int
val add : t -> Span.t -> t
val sub : t -> Span.t -> t
val diff : t -> t -> Span.t
val next : t -> t
val prev : t -> t
val to_span_since_epoch : t -> Span.t
val of_span_since_epoch : Span.t -> 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
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base.Or_error.t
type comparator_witness
= Time.comparator_witness
val comparator : (t, comparator_witness) Base.Comparator.comparator
val validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
module Date_and_ofday = Time.Date_and_ofday
val next_multiple : ?can_equal_after:Core_kernel__.Import.bool -> base:t -> after:t -> interval:Span.t -> Core_kernel__.Import.unit -> t
val prev_multiple : ?can_equal_before:Core_kernel__.Import.bool -> base:t -> before:t -> interval:Span.t -> Core_kernel__.Import.unit -> t
val now : Core_kernel__.Import.unit -> t
val now : Core_kernel__.Import.unit -> t
now ()
returns at
representing the current time
module Zone : Core_kernel__.Time_intf.Zone with module Time := Time
Basic operations on times
val add : t -> Span.t -> t
add t s
adds the spans
to timet
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.
include Core_kernel__.Time_intf.Shared with type t := t with module Span := Span with module Ofday := Ofday
include Core_kernel.Quickcheck.S_range with type t := t
include Core_kernel.Quickcheck_intf.S
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t
val gen_incl : t -> t -> t Base_quickcheck.Generator.t
gen_incl lower_bound upper_bound
produces values betweenlower_bound
andupper_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 iflower_bound > upper_bound
.
val gen_uniform_incl : t -> t -> t Base_quickcheck.Generator.t
gen_uniform_incl lower_bound upper_bound
produces a generator for values uniformly distributed betweenlower_bound
andupper_bound
, inclusive. Raises iflower_bound > upper_bound
.
module Span : sig ... end
module Ofday : sig ... end
Comparisons
val is_earlier : t -> than:t -> Core_kernel__.Import.bool
val is_later : t -> than:t -> Core_kernel__.Import.bool
Conversions
val of_date_ofday : zone:Core_kernel__.Zone.t -> Core_kernel__.Time_intf.Date.t -> Ofday.t -> t
val of_date_ofday_precise : Core_kernel__.Time_intf.Date.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__.Time_intf.Date.t * Ofday.t
val to_date_ofday_precise : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Time_intf.Date.t * Ofday.t * [ `Only | `Also_at of t | `Also_skipped of Core_kernel__.Time_intf.Date.t * Ofday.t ]
Always returns the
Date.t * Ofday.t
thatto_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__.Time_intf.Date.t
val to_ofday : t -> zone:Core_kernel__.Zone.t -> Ofday.t
val reset_date_cache : Core_kernel__.Import.unit -> Core_kernel__.Import.unit
For performance testing only;
reset_date_cache ()
resets an internal cache used to speed upto_date
and related functions when called repeatedly on times that fall within the same day.
val epoch : t
midnight, Jan 1, 1970 in UTC
val convert : from_tz:Core_kernel__.Zone.t -> to_tz:Core_kernel__.Zone.t -> Core_kernel__.Time_intf.Date.t -> Ofday.t -> Core_kernel__.Time_intf.Date.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.
include Core_kernel__.Std_internal.Stringable with type t := t
val to_filename_string : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Import.string
to_filename_string t ~zone
convertst
to string with format YYYY-MM-DD_HH-MM-SS.mmm which is suitable for using in filenames.
val of_filename_string : Core_kernel__.Import.string -> zone:Core_kernel__.Zone.t -> t
of_filename_string s ~zone
convertss
that has format YYYY-MM-DD_HH-MM-SS.mmm into time.
val to_string_abs : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Import.string
to_string_abs ~zone t
is the same asto_string t
except that it uses the given time zone.
val to_string_abs_trimmed : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Import.string
to_string_abs_trimmed
is the same asto_string_abs
, but drops trailing seconds and milliseconds if they are 0.
val to_string_abs_parts : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Import.string Core_kernel__.Import.list
val to_string_trimmed : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Import.string
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 -> Core_kernel__.Import.string
Same as
to_string_abs
, but without milliseconds
val of_localized_string : zone:Core_kernel__.Zone.t -> Core_kernel__.Import.string -> 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:(Core_kernel__.Import.unit -> Core_kernel__.Zone.t) -> find_zone:(Core_kernel__.Import.string -> Core_kernel__.Zone.t) -> Core_kernel__.Import.string -> t
of_string_gen ~default_zone ~find_zone s
attempts to parses
as at
, calling out todefault_zone
andfind_zone
as needed.
val to_string_iso8601_basic : t -> zone:Core_kernel__.Zone.t -> Core_kernel__.Import.string
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 aTime.t
that is the occurrence of ofday (in the givenzone
) that is the latest occurrence (<=)time
or the earliest occurrence (>=)time
, according toside
.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 arg_type : t Core_kernel.Command.Arg_type.t
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__.Import.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
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
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 variantt
afterwards.
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 hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core__.Import.Identifiable.S_common with type t := t
val compare : t -> t -> Core_kernel__.Import.int
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
include Core_kernel__.Import.Stringable.S with type t := t
include Core_kernel__.Import.Pretty_printer.S with type t := t
val pp : Base.Formatter.t -> t -> unit
include Core_kernel.Comparable.S_binable with type t := t
include Core_kernel__.Comparable_intf.S_common
include Base.Comparable.S
include Base__.Comparable_intf.Polymorphic_compare
val ascending : t -> t -> int
ascending
is identical tocompare
.descending x y = ascending y x
. These are intended to be mnemonic when used likeList.sort ~compare:ascending
andList.sort ~cmp:descending
, since they cause the list to be sorted in ascending or descending order, respectively.
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
between t ~low ~high
meanslow <= t <= high
val clamp_exn : t -> min:t -> max:t -> t
clamp_exn t ~min ~max
returnst'
, the closest value tot
such thatbetween t' ~low:min ~high:max
is true.Raises if
not (min <= max)
.
val clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
val comparator : (t, comparator_witness) Base.Comparator.comparator
include Base__.Comparable_intf.Validate with type t := t
val validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
module Replace_polymorphic_compare : Core_kernel__.Comparable_intf.Polymorphic_compare with type t := t
include Core_kernel__.Comparable_intf.Map_and_set_binable with type t := t with type comparator_witness := comparator_witness
include Core_kernel.Comparator.S with type t := t
val comparator : (t, comparator_witness) Core_kernel.Comparator.comparator
module Map : Core_kernel.Map.S_binable with type Key.t = t with type Key.comparator_witness = comparator_witness
module Set : Core_kernel.Set.S_binable with type Elt.t = t with type Elt.comparator_witness = comparator_witness
include Core_kernel.Hashable.S_binable with type t := t
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val hashable : t Core_kernel.Hashtbl.Hashable.t
module Table : Core_kernel.Hashtbl.S_binable with type key = t
module Hash_set : Core_kernel.Hash_set.S_binable with type elt = t
module Hash_queue : Core_kernel.Hash_queue.S with type key = t
val of_tm : Core__.Core_unix.tm -> zone:Zone.t -> t
of_tm
converts aUnix.tm
(mirroring astruct tm
from the C stdlib) into aTime.t
. Note that thetm_wday
,tm_yday
, andtm_isdst
fields are ignored.
val of_date_ofday_zoned : Core__.Import.Date.t -> Ofday.Zoned.t -> t
Conversion functions that involved Ofday.Zoned.t, exactly analogous to the conversion functions that involve Ofday.t
val to_date_ofday_zoned : t -> zone:Time.Zone.t -> Core__.Import.Date.t * Ofday.Zoned.t
val to_ofday_zoned : t -> zone:Time.Zone.t -> Ofday.Zoned.t
val to_string_fix_proto : [ `Utc | `Local ] -> t -> string
val of_string_fix_proto : [ `Utc | `Local ] -> string -> t
val 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.
val 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 parses
to at
. Ifs
doesn't supply a time zoneif_no_timezone
is consulted.
val t_of_sexp_abs : Core__.Import.Sexp.t -> t
t_of_sexp_abs sexp
ast_of_sexp
, but demands thatsexp
indicate the timezone the time is expressed in.
val sexp_of_t_abs : t -> zone:Zone.t -> Core__.Import.Sexp.t
Miscellaneous
val pause : Span.t -> unit
pause span
sleeps for span time.
val 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.
val pause_forever : unit -> Core__.Import.never_returns
pause_forever
sleeps indefinitely.
val 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.
val parse : string -> fmt:string -> zone:Zone.t -> t
parse string ~fmt ~zone
parsesstring
, according tofmt
, 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
module Exposed_for_tests : sig ... end