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
|
(* File: utils.mli
Copyright (C) 2007-
Jane Street Holding, LLC
Author: Markus Mottl
email: mmottl\@janestreet.com
WWW: http://www.janestreet.com/ocaml
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
(** Utils: utility functions for user convenience *)
open Bigarray
open Common
open Read_ml
open Type_class
val bin_dump : ?header : bool -> 'a writer -> 'a -> buf
(** [bin_dump ?header writer v] uses [writer] to first compute the size of
[v] in the binary protocol, then allocates a buffer of exactly this
size, and then writes out the value. If [header] is [true], the
size of the resulting binary string will be prefixed as a signed
64bit integer.
@return the buffer containing the written out value.
@param header default = [false]
@raise Failure if the size of the value changes during writing,
and any other exceptions that the binary writer in [writer] can raise.
*)
val bin_read_stream :
?max_size : int ->
read : (buf -> pos : int -> len : int -> unit) ->
'a reader -> 'a
(** [bin_read_stream ?max_size ~read reader] reads binary protocol data
from a stream as generated by the [read] function, which places
data of a given length into a given buffer. Requires a header.
The [reader] type class will be used for conversion to OCaml-values.
@param max_size = nothing
@raise Failure if the size of the value disagrees with the one
specified in the header, and any other exceptions that the binary
reader associated with [reader] can raise.
@raise Failure if the size reported in the data header is longer than
[max_size].
*)
(** Conversion of binable types *)
module type Make_binable_spec = sig
module Binable : Binable.S
type t
val to_binable : t -> Binable.binable
val of_binable : Binable.binable -> t
end
module Make_binable (Bin_spec : Make_binable_spec)
: Binable.S with type binable = Bin_spec.t
module type Make_binable1_spec = sig
module Binable : Binable.S1
type 'a t
val to_binable : 'a t -> 'a Binable.binable
val of_binable : 'a Binable.binable -> 'a t
end
module Make_binable1 (Bin_spec : Make_binable1_spec)
: Binable.S1 with type 'a binable = 'a Bin_spec.t
module type Make_binable2_spec = sig
module Binable : Binable.S2
type ('a, 'b) t
val to_binable : ('a, 'b) t -> ('a, 'b) Binable.binable
val of_binable : ('a, 'b) Binable.binable -> ('a, 'b) t
end
module Make_binable2 (Bin_spec : Make_binable2_spec)
: Binable.S2 with type ('a, 'b) binable = ('a, 'b) Bin_spec.t
(** Conversion of iterable types *)
module type Make_iterable_binable_spec = sig
type t
type el
type acc
val module_name : string option
val length : t -> int
val iter : f : (el -> unit) -> t -> unit
val init : int -> acc
val insert : acc -> el -> int -> acc
val finish : acc -> t
val bin_size_el : el Size.sizer
val bin_write_el_ : el Unsafe_write_c.writer
val bin_read_el_ : el Unsafe_read_c.reader
end
module Make_iterable_binable (Iterable_spec : Make_iterable_binable_spec)
: Binable.S with type binable = Iterable_spec.t
module type Make_iterable_binable1_spec = sig
type 'a t
type 'a el
type 'a acc
val module_name : string option
val length : 'a t -> int
val iter : f : ('a el -> unit) -> 'a t -> unit
val init : int -> 'a acc
val insert : 'a acc -> 'a el -> int -> 'a acc
val finish : 'a acc -> 'a t
val bin_size_el : ('a, 'a el) Size.sizer1
val bin_write_el_ : ('a, 'a el) Unsafe_write_c.writer1
val bin_read_el_ : ('a, 'a el) Unsafe_read_c.reader1
end
module Make_iterable_binable1 (Iterable_spec : Make_iterable_binable1_spec)
: Binable.S1 with type 'a binable = 'a Iterable_spec.t
module type Make_iterable_binable2_spec = sig
type ('a, 'b) t
type ('a, 'b) el
type ('a, 'b) acc
val module_name : string option
val length : ('a, 'b) t -> int
val iter : f : (('a, 'b) el -> unit) -> ('a, 'b) t -> unit
val init : int -> ('a, 'b) acc
val insert : ('a, 'b) acc -> ('a, 'b) el -> int -> ('a, 'b) acc
val finish : ('a, 'b) acc -> ('a, 'b) t
val bin_size_el : ('a, 'b, ('a, 'b) el) Size.sizer2
val bin_write_el_ : ('a, 'b, ('a, 'b) el) Unsafe_write_c.writer2
val bin_read_el_ : ('a, 'b, ('a, 'b) el) Unsafe_read_c.reader2
end
module Make_iterable_binable2 (Iterable_spec : Make_iterable_binable2_spec)
: Binable.S2 with type ('a, 'b) binable = ('a, 'b) Iterable_spec.t
|
