Source file duration.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
[@@@ocaml.alert "-protobuf"]
(**/**)
module Runtime' = Ocaml_protoc_plugin [@@warning "-33"]
module Imported'modules = struct
end
(**/**)
module rec Google : sig
module rec Protobuf : sig
(**
A Duration represents a signed, fixed-length span of time represented
as a count of seconds and fractions of seconds at nanosecond
resolution. It is independent of any calendar and concepts like "day"
or "month". It is related to Timestamp in that the difference between
two Timestamp values is a Duration and it can be added or subtracted
from a Timestamp. Range is approximately +-10,000 years.
# Examples
Example 1: Compute Duration from two Timestamps in pseudo code.
{v
Timestamp start = ...;
Timestamp end = ...;
Duration duration = ...;
duration.seconds = end.seconds - start.seconds;
duration.nanos = end.nanos - start.nanos;
if (duration.seconds < 0 && duration.nanos > 0) {
duration.seconds += 1;
duration.nanos -= 1000000000;
} else if (duration.seconds > 0 && duration.nanos < 0) {
duration.seconds -= 1;
duration.nanos += 1000000000;
}
v}
Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
{v
Timestamp start = ...;
Duration duration = ...;
Timestamp end = ...;
end.seconds = start.seconds + duration.seconds;
end.nanos = start.nanos + duration.nanos;
if (end.nanos < 0) {
end.seconds -= 1;
end.nanos += 1000000000;
} else if (end.nanos >= 1000000000) {
end.seconds += 1;
end.nanos -= 1000000000;
}
v}
Example 3: Compute Duration from datetime.timedelta in Python.
{v
td = datetime.timedelta(days=3, minutes=10)
duration = Duration()
duration.FromTimedelta(td)
v}
# JSON Mapping
In JSON format, the Duration type is encoded as a string rather than an
object, where the string ends in the suffix "s" (indicating seconds) and
is preceded by the number of seconds, with nanoseconds expressed as
fractional seconds. For example, 3 seconds with 0 nanoseconds should be
encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
be expressed in JSON format as "3.000000001s", and 3 seconds and 1
microsecond should be expressed in JSON format as "3.000001s".
*)
module rec Duration : sig
type t = {
seconds: int;(** Signed seconds of the span of time. Must be from -315,576,000,000
to +315,576,000,000 inclusive. Note: these bounds are computed from:
60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years *)
nanos: int;(** Signed fractions of a second at nanosecond resolution of the span
of time. Durations less than one second are represented with a 0
`seconds` field and a positive or negative `nanos` field. For durations
of one second or more, a non-zero value for the `nanos` field must be
of the same sign as the `seconds` field. Must be from -999,999,999
to +999,999,999 inclusive. *)
}
val make: ?seconds:int -> ?nanos:int -> unit -> t
(** Helper function to generate a message using default values *)
val to_proto: t -> Runtime'.Writer.t
(** Serialize the message to binary format *)
val from_proto: Runtime'.Reader.t -> (t, [> Runtime'.Result.error]) result
(** Deserialize from binary format *)
val to_json: Runtime'.Json_options.t -> t -> Runtime'.Json.t
(** Serialize to Json (compatible with Yojson.Basic.t) *)
val from_json: Runtime'.Json.t -> (t, [> Runtime'.Result.error]) result
(** Deserialize from Json (compatible with Yojson.Basic.t) *)
val name: unit -> string
(** Fully qualified protobuf name of this message *)
(**/**)
type make_t = ?seconds:int -> ?nanos:int -> unit -> t
val merge: t -> t -> t
val to_proto': Runtime'.Writer.t -> t -> unit
val from_proto_exn: Runtime'.Reader.t -> t
val from_json_exn: Runtime'.Json.t -> t
(**/**)
end
end
end = struct
module rec Protobuf : sig
(**
A Duration represents a signed, fixed-length span of time represented
as a count of seconds and fractions of seconds at nanosecond
resolution. It is independent of any calendar and concepts like "day"
or "month". It is related to Timestamp in that the difference between
two Timestamp values is a Duration and it can be added or subtracted
from a Timestamp. Range is approximately +-10,000 years.
# Examples
Example 1: Compute Duration from two Timestamps in pseudo code.
{v
Timestamp start = ...;
Timestamp end = ...;
Duration duration = ...;
duration.seconds = end.seconds - start.seconds;
duration.nanos = end.nanos - start.nanos;
if (duration.seconds < 0 && duration.nanos > 0) {
duration.seconds += 1;
duration.nanos -= 1000000000;
} else if (duration.seconds > 0 && duration.nanos < 0) {
duration.seconds -= 1;
duration.nanos += 1000000000;
}
v}
Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
{v
Timestamp start = ...;
Duration duration = ...;
Timestamp end = ...;
end.seconds = start.seconds + duration.seconds;
end.nanos = start.nanos + duration.nanos;
if (end.nanos < 0) {
end.seconds -= 1;
end.nanos += 1000000000;
} else if (end.nanos >= 1000000000) {
end.seconds += 1;
end.nanos -= 1000000000;
}
v}
Example 3: Compute Duration from datetime.timedelta in Python.
{v
td = datetime.timedelta(days=3, minutes=10)
duration = Duration()
duration.FromTimedelta(td)
v}
# JSON Mapping
In JSON format, the Duration type is encoded as a string rather than an
object, where the string ends in the suffix "s" (indicating seconds) and
is preceded by the number of seconds, with nanoseconds expressed as
fractional seconds. For example, 3 seconds with 0 nanoseconds should be
encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
be expressed in JSON format as "3.000000001s", and 3 seconds and 1
microsecond should be expressed in JSON format as "3.000001s".
*)
module rec Duration : sig
type t = {
seconds: int;(** Signed seconds of the span of time. Must be from -315,576,000,000
to +315,576,000,000 inclusive. Note: these bounds are computed from:
60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years *)
nanos: int;(** Signed fractions of a second at nanosecond resolution of the span
of time. Durations less than one second are represented with a 0
`seconds` field and a positive or negative `nanos` field. For durations
of one second or more, a non-zero value for the `nanos` field must be
of the same sign as the `seconds` field. Must be from -999,999,999
to +999,999,999 inclusive. *)
}
val make: ?seconds:int -> ?nanos:int -> unit -> t
(** Helper function to generate a message using default values *)
val to_proto: t -> Runtime'.Writer.t
(** Serialize the message to binary format *)
val from_proto: Runtime'.Reader.t -> (t, [> Runtime'.Result.error]) result
(** Deserialize from binary format *)
val to_json: Runtime'.Json_options.t -> t -> Runtime'.Json.t
(** Serialize to Json (compatible with Yojson.Basic.t) *)
val from_json: Runtime'.Json.t -> (t, [> Runtime'.Result.error]) result
(** Deserialize from Json (compatible with Yojson.Basic.t) *)
val name: unit -> string
(** Fully qualified protobuf name of this message *)
(**/**)
type make_t = ?seconds:int -> ?nanos:int -> unit -> t
val merge: t -> t -> t
val to_proto': Runtime'.Writer.t -> t -> unit
val from_proto_exn: Runtime'.Reader.t -> t
val from_json_exn: Runtime'.Json.t -> t
(**/**)
end
end = struct
module rec Duration : sig
type t = {
seconds: int;(** Signed seconds of the span of time. Must be from -315,576,000,000
to +315,576,000,000 inclusive. Note: these bounds are computed from:
60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years *)
nanos: int;(** Signed fractions of a second at nanosecond resolution of the span
of time. Durations less than one second are represented with a 0
`seconds` field and a positive or negative `nanos` field. For durations
of one second or more, a non-zero value for the `nanos` field must be
of the same sign as the `seconds` field. Must be from -999,999,999
to +999,999,999 inclusive. *)
}
val make: ?seconds:int -> ?nanos:int -> unit -> t
(** Helper function to generate a message using default values *)
val to_proto: t -> Runtime'.Writer.t
(** Serialize the message to binary format *)
val from_proto: Runtime'.Reader.t -> (t, [> Runtime'.Result.error]) result
(** Deserialize from binary format *)
val to_json: Runtime'.Json_options.t -> t -> Runtime'.Json.t
(** Serialize to Json (compatible with Yojson.Basic.t) *)
val from_json: Runtime'.Json.t -> (t, [> Runtime'.Result.error]) result
(** Deserialize from Json (compatible with Yojson.Basic.t) *)
val name: unit -> string
(** Fully qualified protobuf name of this message *)
(**/**)
type make_t = ?seconds:int -> ?nanos:int -> unit -> t
val merge: t -> t -> t
val to_proto': Runtime'.Writer.t -> t -> unit
val from_proto_exn: Runtime'.Reader.t -> t
val from_json_exn: Runtime'.Json.t -> t
(**/**)
end = struct
module This'_ = Duration
let name () = ".google.protobuf.Duration"
type t = {
seconds: int;(** Signed seconds of the span of time. Must be from -315,576,000,000
to +315,576,000,000 inclusive. Note: these bounds are computed from:
60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years *)
nanos: int;(** Signed fractions of a second at nanosecond resolution of the span
of time. Durations less than one second are represented with a 0
`seconds` field and a positive or negative `nanos` field. For durations
of one second or more, a non-zero value for the `nanos` field must be
of the same sign as the `seconds` field. Must be from -999,999,999
to +999,999,999 inclusive. *)
}
type make_t = ?seconds:int -> ?nanos:int -> unit -> t
let make ?(seconds = 0) ?(nanos = 0) () = { seconds; nanos }
let merge =
let merge_seconds = Runtime'.Merge.merge Runtime'.Spec.( basic ((1, "seconds", "seconds"), int64_int, (0)) ) in
let merge_nanos = Runtime'.Merge.merge Runtime'.Spec.( basic ((2, "nanos", "nanos"), int32_int, (0)) ) in
fun t1 t2 -> {
seconds = (merge_seconds t1.seconds t2.seconds);
nanos = (merge_nanos t1.nanos t2.nanos);
}
let spec () = Runtime'.Spec.( basic ((1, "seconds", "seconds"), int64_int, (0)) ^:: basic ((2, "nanos", "nanos"), int32_int, (0)) ^:: nil )
let to_proto' =
let serialize = Runtime'.apply_lazy (fun () -> Runtime'.Serialize.serialize (spec ())) in
fun writer { seconds; nanos } -> serialize writer seconds nanos
let to_proto t = let writer = Runtime'.Writer.init () in to_proto' writer t; writer
let from_proto_exn =
let constructor seconds nanos = { seconds; nanos } in
Runtime'.apply_lazy (fun () -> Runtime'.Deserialize.deserialize (spec ()) constructor)
let from_proto writer = Runtime'.Result.catch (fun () -> from_proto_exn writer)
let to_json options =
let serialize = Runtime'.Serialize_json.serialize ~message_name:(name ()) (spec ()) options in
fun { seconds; nanos } -> serialize seconds nanos
let from_json_exn =
let constructor seconds nanos = { seconds; nanos } in
Runtime'.apply_lazy (fun () -> Runtime'.Deserialize_json.deserialize ~message_name:(name ()) (spec ()) constructor)
let from_json json = Runtime'.Result.catch (fun () -> from_json_exn json)
end
end
end