timedesc 0.8.0 · OCaml Package

type t

Representation of time of day

type view = private {

hour : int;
minute : int;
second : int;
ns : int;

}

type error = [

| `Invalid_hour of int
| `Invalid_minute of int
| `Invalid_second of int
| `Invalid_s_frac of float
| `Invalid_ns of int

]

exception Error_exn of error

Constructors

val make : 
  ?ns:int ->
  ?s_frac:float ->
  hour:int ->
  minute:int ->
  second:int ->
  unit ->
  (t, error) Stdlib.result

Constructs t from specification of the time of day.

Leap second can be specified by providing 60 for second. Note that leap second informtation is lost upon translation to timestamp(s), specifically second 60 is treated as second 59.

24:00:00 is treated as 23:59:59.999_999_999.

Nanosecond used is the addition of ns and s_frac * 10^9.

Returns Error `Invalid_hour if hour < 0 || 24 < hour.

Returns Error `Invalid_hour if hour = 24 and minute <> 0 || second <> 0 || total ns <> 0.

Returns Error `Invalid_minute if minute < 0 || 59 < minute.

Returns Error `Invalid_second if second < 0 || 60 < second.

Returns Error `Invalid_ns if s_frac < 0.0.

Returns Error `Invalid_ns if ns < 0.

Returns Error `Invalid_ns if total ns >= 10^9.

val make_exn : 
  ?ns:int ->
  ?s_frac:float ->
  hour:int ->
  minute:int ->
  second:int ->
  unit ->
  t

Comparison

val equal : t -> t -> bool

Viewer

val view : t -> view

Accessors

val hour : t -> int

val minute : t -> int

val second : t -> int

val ns : t -> int

val is_leap_second : t -> bool

Conversion

val to_span : t -> Span.t

val of_span : Span.t -> t option

Pretty printing

val pp_rfc3339 : ?frac_s:int -> unit -> Stdlib.Format.formatter -> t -> unit

val pp_rfc3339_milli : Stdlib.Format.formatter -> t -> unit

val pp_rfc3339_micro : Stdlib.Format.formatter -> t -> unit

val pp_rfc3339_nano : Stdlib.Format.formatter -> t -> unit

val to_rfc3339 : ?frac_s:int -> t -> string

val to_rfc3339_milli : t -> string

val to_rfc3339_micro : t -> string

val to_rfc3339_nano : t -> string

Parsing

val of_iso8601 : string -> (t, string) Stdlib.result

val of_iso8601_exn : string -> t

raises ISO8601_parse_exn
if of_iso8601 fails

Sexp

val to_sexp : t -> Sexplib.Sexp.t

val to_sexp_string : t -> string

val of_sexp : Sexplib.Sexp.t -> (t, string) Stdlib.result

val of_sexp_string : string -> (t, string) Stdlib.result

val pp_sexp : Stdlib.Format.formatter -> t -> unit

package timedesc