package core

  1. Overview
  2. Docs
package core
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file zone_intf.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
(** Time-zone handling. *)

open! Import

(** The internal time representation of [Zone.t]. This is a tiny subset of [Time0_intf.S],
    see that interface for details such as the meaning of [Span] and [Date_and_ofday].

    The name of the interface reflects the fact that the interface only gives you access
    to the seconds of the [t]. But you can use this interface with types that have higher
    precision than that, hence the rounding implied in the name of
    [to_int63_seconds_round_down_exn].
*)
module type Time_in_seconds = sig
  module Span : sig
    type t

    val of_int63_seconds : Int63.t -> t
    val to_int63_seconds_round_down_exn : t -> Int63.t
  end

  module Date_and_ofday : sig
    type t

    val of_synthetic_span_since_epoch : Span.t -> t
    val to_synthetic_span_since_epoch : t -> Span.t
  end

  type t

  val of_span_since_epoch : Span.t -> t
  val to_span_since_epoch : t -> Span.t
end

(** This is the interface of [Zone], but not the interface of [Time.Zone] or
    [Time_ns.Zone]. For those, look at [Time_intf.Zone] *)
module type S = sig
  (** {1 User-friendly interface} *)

  (** The type of a time-zone.

      bin_io and sexp representations of Zone.t are the name of the zone, and
      not the full data that is read from disk when Zone.find is called.  The
      full Zone.t is reconstructed on the receiving/reading side by reloading
      the zone file from disk.  Any zone name that is accepted by [find] is
      acceptable in the bin_io and sexp representations. *)
  type t [@@deriving sexp_of, compare]

  (** [input_tz_file ~zonename ~filename] read in [filename] and return [t]
      with [name t] = [zonename] *)
  val input_tz_file : zonename:string -> filename:string -> t

  (** [likely_machine_zones] is a list of zone names that will be searched
      first when trying to determine the machine zone of a box.  Setting this
      to a likely set of zones for your application will speed the very first
      use of the local timezone. *)
  val likely_machine_zones : string list ref

  (** [of_utc_offset offset] returns a timezone with a static UTC offset (given in
      hours). *)
  val of_utc_offset : hours:int -> t

  val of_utc_offset_explicit_name : name:string -> hours:int -> t

  (** [utc] the UTC time zone.  Included for convenience *)
  val utc : t

  val name : t -> string

  (** [original_filename t] return the filename [t] was loaded from (if any) *)
  val original_filename : t -> string option

  (** [digest t] return the MD5 digest of the file the t was created from (if any) *)
  val digest : t -> Md5.t option

  module Time_in_seconds : Time_in_seconds

  (** For performance testing only; [reset_transition_cache t] resets an internal cache in
      [t] used to speed up repeated lookups of the same clock shift transition. *)
  val reset_transition_cache : t -> unit

  (** A time zone index refers to a range of times delimited by DST transitions at one or
      both ends. Every time belongs to exactly one such range. The times of DST
      transitions themselves belong to the range for which they are the lower bound. *)
  module Index : sig
    type t [@@immediate]

    val next : t -> t
    val prev : t -> t
  end

  (** Gets the index of a time. *)
  val index : t -> Time_in_seconds.t -> Index.t

  val index_of_date_and_ofday : t -> Time_in_seconds.Date_and_ofday.t -> Index.t

  (** Gets the UTC offset of times in a specific range.

      This can raise if you use an [Index.t] that is out of bounds for this [t]. *)
  val index_offset_from_utc_exn : t -> Index.t -> Time_in_seconds.Span.t

  (** [index_abbreviation_exn t index] returns the abbreviation name (such as EDT, EST,
      JST) of given zone [t] for the range of [index]. This string conversion is one-way
      only, and cannot reliably be turned back into a [t]. This function reads and writes
      the zone's cached index. Raises if [index] is out of bounds for [t]. *)
  val index_abbreviation_exn : t -> Index.t -> string

  (** Accessors for the DST transitions delimiting the start and end of a range, if any.
      The [_exn] accessors raise if there is no such transition. These accessors are split
      up to increase performance and improve allocation; they are intended as a low-level
      back-end for commonly-used time conversion functions. See [Time.Zone] and
      [Time_ns.Zone] for higher-level accessors that return an optional tuple for clock
      shifts in either direction. *)
  val index_has_prev_clock_shift : t -> Index.t -> bool

  val index_prev_clock_shift_time_exn : t -> Index.t -> Time_in_seconds.t
  val index_prev_clock_shift_amount_exn : t -> Index.t -> Time_in_seconds.Span.t
  val index_has_next_clock_shift : t -> Index.t -> bool
  val index_next_clock_shift_time_exn : t -> Index.t -> Time_in_seconds.t
  val index_next_clock_shift_amount_exn : t -> Index.t -> Time_in_seconds.Span.t
end

module type S_stable = sig
  type t

  module Full_data : sig
    module V1 : Stable_module_types.S0_without_comparator with type t = t
  end
end

module type Zone = sig
  module type S = S
  module type S_stable = S_stable

  include S
  module Stable : S_stable with type t := t
end