package timmy-jsoo

You can search for identifiers within the package.

in-package search v0.2.0

package timmy-jsoo

timmy-jsoo
- Timmy_jsoo
  - Date
  - Daytime
  - Time
  - Timezone
  - Versions
    
    V1_1
  - Week
timmy-jsoo.clock
- Clock

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of Timmy.Time

A point in time.

Type

type t = Timmy.Time.t

A point in time.

type js = Js_of_ocaml.Js.date Js_of_ocaml.Js.t

Time representation in javascript.

Construction

Timmy leaves the burden of determining the current time to Ptime_clock. Pick the right ptime.clock library for your platform and use Timmy.Time.of_ptime (Ptime_clock.now ()).

Well known values

val epoch : Timmy.Time.t

epoch is January 1, 1970 00:00:00 UTC/GMT.

Time manipulation

Comparison

include Base.Comparable.S with type t := Timmy.Time.t

include Base.Comparisons.S with type t := Timmy.Time.t

include Base.Comparisons.Infix with type t := Timmy.Time.t

val equal : Timmy.Time.t -> Timmy.Time.t -> bool

val compare : Timmy.Time.t -> Timmy.Time.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 min : Timmy.Time.t -> Timmy.Time.t -> Timmy.Time.t

val max : Timmy.Time.t -> Timmy.Time.t -> Timmy.Time.t

val ascending : Timmy.Time.t -> Timmy.Time.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.Time.t -> Timmy.Time.t -> int

val between : Timmy.Time.t -> low:Timmy.Time.t -> high:Timmy.Time.t -> bool

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

val clamp_exn : 
  Timmy.Time.t ->
  min:Timmy.Time.t ->
  max:Timmy.Time.t ->
  Timmy.Time.t

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.Time.t ->
  min:Timmy.Time.t ->
  max:Timmy.Time.t ->
  Timmy.Time.t Base.Or_error.t

include Base.Comparator.S with type t := Timmy.Time.t

type comparator_witness = Timmy.Time.comparator_witness

val comparator : (Timmy.Time.t, comparator_witness) Base.Comparator.comparator

Operators

module O = Timmy.Time.O

Convenience module to only pull operators.

include module type of O

Convenience module to only pull operators.

include Base.Comparable.Infix with type t := Timmy.Time.t

val (>=) : Timmy.Time.t -> Timmy.Time.t -> bool

val (<=) : Timmy.Time.t -> Timmy.Time.t -> bool

val (=) : Timmy.Time.t -> Timmy.Time.t -> bool

val (>) : Timmy.Time.t -> Timmy.Time.t -> bool

val (<) : Timmy.Time.t -> Timmy.Time.t -> bool

val (<>) : Timmy.Time.t -> Timmy.Time.t -> bool

val (+) : Timmy.Time.t -> Span.t -> Timmy.Time.t

time + span is the time point span after time.

val (-) : Timmy.Time.t -> Timmy.Time.t -> Span.t

end - start is the duration elapsed from start to end.

Scalar conversions

Pretty-print

val pp : Timmy.Time.t Fmt.t

pp f date prints date to f in an unspecified, human readable format.

String

val to_string : ?timezone:Timmy.Timezone.t -> Timmy.Time.t -> Base.string

to_string time is the RCF3339 representation of time, eg. 2021-10-04.

val of_string : Base.string -> (Timmy.Time.t, Base.string) Base.Result.t

of_string s is the time represented by s as per RCF3339 or a relevant error message if it is invalid.

val to_rfc3339 : ?timezone:Timmy.Timezone.t -> Timmy.Time.t -> Base.string

of_rfc3339 is to_string.

val of_rfc3339 : Base.string -> (Timmy.Time.t, Base.string) Base.Result.t

of_rfc3339 is of_string.

Ptime

val of_ptime : Ptime.t -> Timmy.Time.t

of_ptime ptime is the time equivalent to ptime.

val to_ptime : Timmy.Time.t -> Ptime.t

to_ptime time is the Ptime time equivalent to time.

val to_js : Timmy.Time.t -> js

val of_js : js -> Timmy.Time.t