package timmy-jsoo

  1. Overview
  2. Docs

Module Timmy_jsoo.Daytime

include module type of struct include Timmy.Daytime end

Type

type t = private Timmy.Daytime.t = {
  1. hours : int;
  2. minutes : int;
  3. seconds : int;
}

A time of the day.

Construction

val make : hours:Base.int -> minutes:Base.int -> seconds:Base.int -> (Timmy.Daytime.t, Base.string) Base.Result.t

make ~hours ~minutes ~int is { hours; minutes; seconds } if it represents a valid time of the day or a relevant error message otherwise.

Well known values

val latest : Timmy.Daytime.t

latest is {hours = 23; minutes = 59; seconds = 59}

val midnight : Timmy.Daytime.t

midnight is {hours = 0; minutes = 0; seconds = 0}

val noon : Timmy.Daytime.t

noon is {hours = 12; minutes = 0; seconds = 0}

Time manipulation

val with_daytime : timezone:Timmy.Timezone.t -> Timmy.Daytime.t -> Timmy.Time.t -> Timmy.Time.t

with_daytime ~timezone daytime time is daytime time of the day on the same date as time in timezone.

val truncate_seconds : Timmy.Daytime.t -> Timmy.Daytime.t

truncate_seconds daytime is daytime with seconds set to 0.

val truncate_minutes : Timmy.Daytime.t -> Timmy.Daytime.t

truncate_minutes daytime is daytime with minutes and seconds set to 0.

Time conversions

val of_time : timezone:Timmy.Timezone.t -> Timmy.Time.t -> Timmy.Daytime.t

of_time ~timezone time is the time of the day at time in timezone.

to_time ~timezone date daytime is the time at daytime on date in timezone. When the date and datetime do not exist in timezone because of a time transition (eg. daylight saving), the returned time will be shifted to an existing hour. The manner in which the shift is applied is system dependant.

Comparison

include Base.Comparable.S with type t := t
val equal : Timmy.Daytime.t -> Timmy.Daytime.t -> bool
val compare : Timmy.Daytime.t -> Timmy.Daytime.t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

val ascending : Timmy.Daytime.t -> Timmy.Daytime.t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : Timmy.Daytime.t -> Timmy.Daytime.t -> int
val between : Timmy.Daytime.t -> low:Timmy.Daytime.t -> high:Timmy.Daytime.t -> bool

between t ~low ~high means low <= t <= high

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : Timmy.Daytime.t -> min:Timmy.Daytime.t -> max:Timmy.Daytime.t -> Timmy.Daytime.t Base__.Or_error.t
type comparator_witness = Timmy.Daytime.comparator_witness
val comparator : (Timmy.Daytime.t, comparator_witness) Base__.Comparator.comparator

Operators

module O = Timmy.Daytime.O

Convenience module to only pull operators.

include module type of O
include Base.Comparable.Infix with type t := Timmy__.Daytime.t
val (>=) : Timmy.Daytime.t -> Timmy.Daytime.t -> bool
val (<=) : Timmy.Daytime.t -> Timmy.Daytime.t -> bool
val (=) : Timmy.Daytime.t -> Timmy.Daytime.t -> bool
val (>) : Timmy.Daytime.t -> Timmy.Daytime.t -> bool
val (<) : Timmy.Daytime.t -> Timmy.Daytime.t -> bool
val (<>) : Timmy.Daytime.t -> Timmy.Daytime.t -> bool

daytime + span is the daytime after span has elapsed, or a relevant error message if the result is out of bounds.

Scalar conversions

Integer

val to_int : Timmy.Daytime.t -> Base.int

to_int daytime the number of seconds from midnight to daytime.

of_int n the daytime n seconds after midnight or a relevant error message if the result is out of bounds.

Pretty-print

pp f daytime prints daytime to f in RFC3339 format, eg. 12:43:51.

val pp_opt : ?format:[ `_12 | `_24 ] -> ?precision:[ `Hours | `Minutes | `Seconds ] -> ?size:[ `Long | `Short ] -> Base.unit -> Timmy.Daytime.t Fmt.t

pp_opt ~format ~precision ~size () f daytime pretty-prints daytime to f according to the given options.

  • format: `_12 prints in a US-style twelve hour format (eg. 12AM, 1:30AM, 12PM, 1:30PM), `_24 prints in twelve twenty-four hour format (eg. 00:00, 1:30, 12:00, 13:30). Default is `_24.
  • precision: `Hours displays only hours (eg. 1PM, 13), `Minutes also displays minutes (eg. 13:42, 1:42PM) and `Seconds additionally displays seconds (eg. 13:42:51, 1:42:51PM). Default is `Seconds.
  • size: `Long displays null minutes and seconds (eg. 12:42:00, 13:00:00) while `Short omits them (eg. 12:42, 13). Default is `Short.

Tuple

to_tuple { hours; minutes; seconds } is (hours, minutes, seconds).

of_tuple (hours, minutes, seconds) is the corresponding time of the day if it is valid or a relevant error message otherwise.

of_tuple (hours, minutes, seconds) is the corresponding time of the day

  • raises Failure

    if the time of the day is invalid.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct