module type S_kernel_without_zone = sig ... end
module type S_kernel = sig ... end
include module type of sig ... end
module Ofday : module type of sig ... end with module Ofday.Stable := Core_kernel__Ofday_float.Stable
type underlying = Base.Float.t
type t = private underlying
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 -> Base.Int.t
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.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
module Replace_polymorphic_compare : Comparable.Polymorphic_compare with type t := t
include Comparable.S_common with type t := t and module Replace_polymorphic_compare := Replace_polymorphic_compare
include Base.Comparable.S with type t := t
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
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 : sig ... end with type Date_and_ofday.absolute := t
Equivalent to a
Date.t
and anOfday.t
with no time zone. ADate_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:Span.t -> Base.Unit.t -> t
next_multiple ~base ~after ~interval
returns the smallesttime
of the form:time = base + k * interval
where
k >= 0
andtime > after
. It is an error ifinterval <= 0
.Supplying
~can_equal_after:true
allows the result to satisfytime >= after
.
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 largesttime
of the form:time = base + k * interval
where
k >= 0
andtime < before
. It is an error ifinterval <= 0
.Supplying
~can_equal_before:true
allows the result to satisfytime <= before
.
val now : Base.Unit.t -> t
module Stable : sig ... end
val now : Base.Unit.t -> t
now ()
returns at
representing the current time
module Zone : sig ... end
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 Quickcheck.S_range with type t := t
include Quickcheck_intf.S with type t := t
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
.
Comparisons
val is_earlier : t -> than:t -> Base.Bool.t
val is_later : t -> than:t -> Base.Bool.t
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
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__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 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__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.
Other string conversions
val to_filename_string : t -> zone:Core_kernel__Zone.t -> Base.String.t
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 : Base.String.t -> 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 -> Base.String.t
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 -> Base.String.t
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 -> 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 parses
as at
, calling out todefault_zone
andfind_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 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.
module Stable : sig ... end