module Time:Our time module. This module wraps up unix times, including various convenience functions for accessing them.sig
..end
typet =
Time_internal.T.t
val use_new_string_and_sexp_formats : unit -> unit
val forbid_new_string_and_sexp_formats : unit -> unit
val current_string_and_sexp_format : unit -> [ `Force_old | `New | `Old ]
include Hashable_binable
include Comparable_binable
include Robustly_comparable
include Sexpable
include Binable
include Stringable
include Floatable
val epoch : t
val add : t -> Span.t -> t
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.
val sub : t -> Span.t -> t
sub t s
subtracts the span s
from time t
and returns the
resulting time. See important note for add
.val diff : t -> t -> Span.t
diff t1 t2
returns time t1
minus time t2
.val abs_diff : t -> t -> Span.t
abs_diff t1 t2
returns the absolute span of time t1
minus time t2
.val of_date_ofday : Zone.t -> Date.t -> Ofday.t -> t
val to_date_ofday : t -> Zone.t -> Date.t * Ofday.t
val to_date : t -> Zone.t -> Date.t
val to_ofday : t -> Zone.t -> Ofday.t
val of_local_date_ofday : Date.t -> Ofday.t -> t
val to_local_date_ofday : t -> Date.t * Ofday.t
val to_local_date : t -> Date.t
val to_local_ofday : t -> Ofday.t
val convert : from_tz:Zone.t -> to_tz:Zone.t -> Date.t -> Ofday.t -> Date.t * Ofday.t
val to_filename_string : t -> string
to_filename_string t
converts t
to string with format YYYY-MM-DD_HH-MM-SS.mmm
which is suitable for using in filenames
of_filename_string s
converts s
that has format YYYY-MM-DD_HH-MM-SS.mmm into time
val of_filename_string : string -> t
val to_string_fix_proto : [ `Local | `Utc ] -> t -> string
val of_string_fix_proto : [ `Local | `Utc ] -> string -> t
val to_string_trimmed : t -> string
to_string_trimmed t
Same as to_string, but removes trailing seconds and
milliseconds if they are 0val to_sec_string : t -> string
to_sec_string t
Same as to_string, but without millisecondsval to_localized_string : t -> Zone.t -> string
to_localized_string time zone
returns a string representation of time
in the given zone in the form like "2008-11-18 15:34:56.123".val of_localized_string : Zone.t -> 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.tval to_string_deprecated : t -> string
to_string_deprecated
returns a string in the old formatval to_string_abs : t -> string
to_string_abs t
returns a string that represents an absolute time, rather than a
local time with an assumed time zone. This string can be round-tripped, even on a
machine in a different time zone than the machine that wrote the string.val of_date_time_strings : string -> string -> t
val of_date_time_strings_utc : string -> string -> t
val pp : Format.formatter -> t -> unit
val now : unit -> t
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 -> Std_internal.never_returns
pause_forever
sleeps indefinitely.val ofday_occurrence : Ofday.t -> [ `right_after | `right_before ] -> t -> t
ofday_occurrence ofday side now
returns a Time.t that is the occurrence of ofday
(in local time) which is the latest occurrence before now or the earliest occurrence
after now, according to side. NOTE: This function is a little bit wrong near daylight
savings timeval ofday_occurrence_utc : Ofday.t -> [ `right_after | `right_before ] -> t -> t
ofday_occurrence ofday side now
returns a Time.t that is the occurrence of ofday
(in UTC) which is the latest occurrence before now or the earliest occurrence after
now, according to side. NOTE: This function is a little bit wrong near daylight
savings timeval format : t -> string -> 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 local timezone.val to_epoch : t -> float
to_epoch t
returns the number of seconds since Jan 1, 1970 00:00:00 in UTC