On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package mtime
Monotonic time spans.
Monotonic time spans
type t = spanSee Mtime.span.
val zero : spanzero is a span of 0ns.
val one : spanone is a span of 1ns.
val max_span : spanmax_span is 264-1ns.
Predicates
is_shorter span ~than is true iff span lasts less than than.
is_longer span ~than is true iff span lasts more than than.
Arithmetic
abs_diff span span' is the absolute difference between span and span'.
Durations
n * dur is n times duration dur.
Warning. Does not check for overflow or that n is positive.
val ns : spanns is a nanosecond duration, 1·10-9s.
val us : spanus is a microsecond duration, 1·10-6s.
val ms : spanms is a millisecond duration, 1·10-3s.
val s : spans is a second duration, 1s.
val min : spanmin is a minute duration, 60s.
val hour : spanhour is an hour duration, 3600s.
val day : spanday is a day duration, 86'400s.
val year : spanyear is a Julian year duration (365.25 days), 31'557'600s.
Converting
val to_uint64_ns : span -> int64to_uint64_ns span is span as an unsigned 64-bit integer nanosecond span.
val of_uint64_ns : int64 -> spanof_uint64_ns u is the unsigned 64-bit integer nanosecond span u as a span.
val of_float_ns : float -> span optionof_float_ns f is the positive floating point nanosecond span f as a span. This is None if f is negative, non finite, or larger or equal than 253 (~104 days, the largest exact floating point integer).
val to_float_ns : span -> floatto_float_ns s is span as a nanosecond floating point span. Note that if s is larger than 253 (~104 days, the largest exact floating point integer) the result is an approximation and will not round trip with of_float_ns.
Formatters
val pp : Format.formatter -> span -> unitpp formats spans according to their magnitude using SI prefixes on seconds and accepted non-SI units. Years are counted in Julian years (365.25 SI-accepted days) as defined by the International Astronomical Union.
Rounds towards positive infinity, i.e. over approximates, no duration is formatted shorter than it is.
The output is UTF-8 encoded, it uses U+03BC for µs (10-6s).
val dump : Format.formatter -> t -> unitdump ppf span formats an unspecified raw representation of span on ppf.
On This Page