timere 0.8.0 · OCaml Package

type t

type error = [

| `Invalid_year of int
| `Invalid_day of int
| `Invalid_hour of int
| `Invalid_minute of int
| `Invalid_second of int
| `Invalid_ns of int
| `Invalid_pattern_combination
| `Invalid_tz_info of string option * Timedesc.Span.t

]

exception Error_exn of error

type lean_toward = [

| `Earlier
| `Later

]

val make : 
  ?tz:Timedesc.Time_zone.t ->
  ?offset_from_utc:Timedesc.Span.t ->
  ?year:int ->
  ?month:int ->
  ?day:int ->
  ?weekday:Timedesc.weekday ->
  ?hour:int ->
  ?minute:int ->
  ?second:int ->
  ?ns:int ->
  lean_toward:lean_toward ->
  unit ->
  (t, error) result

Call must be exactly one of the following forms * (ignoring tz, offset_from_utc and lean_toward which are optional in all cases)

make ~year:_                                                       ~lean_toward ()
  make ~year:_ ~month:_                                              ~lean_toward ()
  make ~year:_ ~month:_ ~day:_                                       ~lean_toward ()
  make ~year:_ ~month:_ ~day:_     ~hour:_                           ~lean_toward ()
  make ~year:_ ~month:_ ~day:_     ~hour:_ ~minute:_                 ~lean_toward ()
  make ~year:_ ~month:_ ~day:_     ~hour:_ ~minute:_ ~second:_       ~lean_toward ()
  make ~year:_ ~month:_ ~day:_     ~hour:_ ~minute:_ ~second:_ ~ns:_ ~lean_toward ()

  make         ~month:_                                              ~lean_toward ()
  make         ~month:_ ~day:_                                       ~lean_toward ()
  make         ~month:_ ~day:_     ~hour:_                           ~lean_toward ()
  make         ~month:_ ~day:_     ~hour:_ ~minute:_                 ~lean_toward ()
  make         ~month:_ ~day:_     ~hour:_ ~minute:_ ~second:_       ~lean_toward ()
  make         ~month:_ ~day:_     ~hour:_ ~minute:_ ~second:_ ~ns:_ ~lean_toward ()

  make                  ~day:_                                       ~lean_toward ()
  make                  ~day:_     ~hour:_                           ~lean_toward ()
  make                  ~day:_     ~hour:_ ~minute:_                 ~lean_toward ()
  make                  ~day:_     ~hour:_ ~minute:_ ~second:_       ~lean_toward ()
  make                  ~day:_     ~hour:_ ~minute:_ ~second:_ ~ns:_ ~lean_toward ()

  make                  ~weekday:_                                   ~lean_toward ()
  make                  ~weekday:_ ~hour:_                           ~lean_toward ()
  make                  ~weekday:_ ~hour:_ ~minute:_                 ~lean_toward ()
  make                  ~weekday:_ ~hour:_ ~minute:_ ~second:_       ~lean_toward ()
  make                  ~weekday:_ ~hour:_ ~minute:_ ~second:_ ~ns:_ ~lean_toward ()

  make                             ~hour:_                           ~lean_toward ()
  make                             ~hour:_ ~minute:_                 ~lean_toward ()
  make                             ~hour:_ ~minute:_ ~second:_       ~lean_toward ()
  make                             ~hour:_ ~minute:_ ~second:_ ~ns:_ ~lean_toward ()

  make                                     ~minute:_                 ~lean_toward ()
  make                                     ~minute:_ ~second:_       ~lean_toward ()
  make                                     ~minute:_ ~second:_ ~ns:_ ~lean_toward ()

  make                                               ~second:_       ~lean_toward ()
  make                                               ~second:_ ~ns:_ ~lean_toward ()

  make                                                         ~ns:_ ~lean_toward ()

returns Error otherwise

val make_exn : 
  ?tz:Timedesc.Time_zone.t ->
  ?offset_from_utc:Timedesc.Span.t ->
  ?year:int ->
  ?month:int ->
  ?day:int ->
  ?weekday:Timedesc.weekday ->
  ?hour:int ->
  ?minute:int ->
  ?second:int ->
  ?ns:int ->
  lean_toward:lean_toward ->
  unit ->
  t

raises Error_exn
if make fails

package timere