package serde

  1. Overview
  2. Docs

Source file 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
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
(* NOTE(@ostera): since standalone module signatures can't be made recursive,
   we use this old trick by making a temporary recursive module structure, that
   allows all these signatures to be co-recursive. Ugly, but does the job
*)
module rec Rec : sig
  type ('tag, 'value, 'error) variant_access = {
    tag : unit -> ('tag, 'error Error.de_error) result;
    unit_variant : unit -> (unit, 'error Error.de_error) result;
    tuple_variant :
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result;
    record_variant :
      'field.
      (module Rec.Visitor_intf with type value = 'value and type tag = 'field) ->
      (module Rec.Visitor_intf with type value = 'field) ->
      fields:string list ->
      ('value, 'error Error.de_error) result;
  }

  type ('value, 'error) map_access = {
    next_key :
      'key.
      deser_key:(unit -> ('key, 'error Error.de_error) result) ->
      ('key option, 'error Error.de_error) result;
    next_value :
      'field.
      deser_value:(unit -> ('field, 'error Error.de_error) result) ->
      ('field option, 'error Error.de_error) result;
  }

  module type Deserializer_base_intf = sig
    type state

    val deserialize_any :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_bool :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_char :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_int :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_float :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_string :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_unit :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_tuple :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_variant :
      'value 'tag.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value and type tag = 'tag) ->
      (module Rec.Visitor_intf with type value = 'tag) ->
      name:string ->
      variants:string list ->
      ('value, 'error Error.de_error) result

    val deserialize_unit_variant :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_tuple_variant :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_record_variant :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_record :
      'value 'field 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value and type tag = 'field) ->
      (module Rec.Visitor_intf with type value = 'field) ->
      name:string ->
      fields:string list ->
      ('value, 'error Error.de_error) result

    val deserialize_seq :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_map :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_identifier :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result
  end

  module type Deserializer_intf = sig
    include Deserializer_base_intf

    val state : state
  end

  module type Visitor_intf = sig
    type value
    type tag

    val visit_bool : bool -> (value, 'error Error.de_error) result
    val visit_unit : unit -> (unit, 'error Error.de_error) result
    val visit_char : char -> (value, 'error Error.de_error) result
    val visit_int : int -> (value, 'error Error.de_error) result
    val visit_float : float -> (value, 'error Error.de_error) result
    val visit_string : string -> (value, 'error Error.de_error) result

    val visit_seq :
      'state.
      (module Rec.Visitor_intf with type value = value) ->
      (module Rec.Deserializer_intf with type state = 'state) ->
      (value, 'error) Sequence_access.t ->
      (value, 'error Error.de_error) result

    val visit_variant :
      (tag, value, 'error) variant_access ->
      (value, 'error Error.de_error) result

    val visit_map :
      'state.
      (module Rec.Visitor_intf with type value = value) ->
      (module Rec.Deserializer_intf with type state = 'state) ->
      (value, 'error) map_access ->
      (value, 'error Error.de_error) result
  end
end = struct
  type ('tag, 'value, 'error) variant_access = {
    tag : unit -> ('tag, 'error Error.de_error) result;
    unit_variant : unit -> (unit, 'error Error.de_error) result;
    tuple_variant :
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result;
    record_variant :
      'field.
      (module Rec.Visitor_intf with type value = 'value and type tag = 'field) ->
      (module Rec.Visitor_intf with type value = 'field) ->
      fields:string list ->
      ('value, 'error Error.de_error) result;
  }

  module type Deserializer_base_intf = sig
    type state

    val deserialize_any :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_bool :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_char :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_int :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_float :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_string :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_unit :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_tuple :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_variant :
      'value 'tag.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value and type tag = 'tag) ->
      (module Rec.Visitor_intf with type value = 'tag) ->
      name:string ->
      variants:string list ->
      ('value, 'error Error.de_error) result

    val deserialize_unit_variant :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_tuple_variant :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_record_variant :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_record :
      'value 'field 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value and type tag = 'field) ->
      (module Rec.Visitor_intf with type value = 'field) ->
      name:string ->
      fields:string list ->
      ('value, 'error Error.de_error) result

    val deserialize_seq :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_map :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result

    val deserialize_identifier :
      'value 'error.
      state ->
      (module Rec.Deserializer_intf with type state = state) ->
      (module Rec.Visitor_intf with type value = 'value) ->
      ('value, 'error Error.de_error) result
  end

  module type Deserializer_intf = sig
    include Deserializer_base_intf

    val state : state
  end

  type ('value, 'error) map_access = {
    next_key :
      'key.
      deser_key:(unit -> ('key, 'error Error.de_error) result) ->
      ('key option, 'error Error.de_error) result;
    next_value :
      'field.
      deser_value:(unit -> ('field, 'error Error.de_error) result) ->
      ('field option, 'error Error.de_error) result;
  }

  module type Visitor_intf = sig
    type value
    type tag

    val visit_bool : bool -> (value, 'error Error.de_error) result
    val visit_unit : unit -> (unit, 'error Error.de_error) result
    val visit_char : char -> (value, 'error Error.de_error) result
    val visit_int : int -> (value, 'error Error.de_error) result
    val visit_float : float -> (value, 'error Error.de_error) result
    val visit_string : string -> (value, 'error Error.de_error) result

    val visit_seq :
      'state.
      (module Rec.Visitor_intf with type value = value) ->
      (module Rec.Deserializer_intf with type state = 'state) ->
      (value, 'error) Sequence_access.t ->
      (value, 'error Error.de_error) result

    val visit_variant :
      (tag, value, 'error) variant_access ->
      (value, 'error Error.de_error) result

    val visit_map :
      'state.
      (module Rec.Visitor_intf with type value = value) ->
      (module Rec.Deserializer_intf with type state = 'state) ->
      (value, 'error) map_access ->
      (value, 'error Error.de_error) result
  end
end

include Rec
OCaml

Innovation. Community. Security.