From 0fd2843431072f5d59d5f947b758ffa549ea0ccd Mon Sep 17 00:00:00 2001 From: Anil Madhavapeddy Date: Fri, 12 Aug 2011 15:28:11 +0100 Subject: [PATCH] delete json in favor of new integrated format --- data/Array.json | 351 ------ data/Base64.json | 34 - data/Bitstring.json | 483 --------- data/Bitstring_config.json | 52 - data/Bitstring_types.json | 40 - data/Block.json | 170 --- data/Buffer.json | 197 ---- data/Callback.json | 39 - data/CamlinternalLazy.json | 58 - data/CamlinternalMod.json | 64 -- data/CamlinternalOO.json | 629 ----------- data/Char.json | 92 -- data/Complex.json | 235 ---- data/Cow.json | 1342 ----------------------- data/Digest.json | 72 -- data/Dns.json | 2065 ------------------------------------ data/Dyntype.json | 188 ---- data/Format.json | 1398 ------------------------ data/Gc.json | 306 ------ data/Hashtbl.json | 247 ----- data/Http.json | 1532 -------------------------- data/Int32.json | 368 ------- data/Int64.json | 412 ------- data/Lazy.json | 88 -- data/Lexing.json | 212 ---- data/List.json | 563 ---------- data/Log.json | 160 --- data/Lwt.json | 550 ---------- data/Lwt_condition.json | 77 -- data/Lwt_list.json | 225 ---- data/Lwt_mutex.json | 91 -- data/Lwt_mvar.json | 73 -- data/Lwt_pool.json | 55 - data/Lwt_pqueue.json | 44 - data/Lwt_sequence.json | 303 ------ data/Lwt_stream.json | 618 ----------- data/Lwt_switch.json | 101 -- data/Lwt_util.json | 145 --- data/Map.json | 48 - data/Marshal.json | 111 -- data/Nativeint.json | 377 ------- data/Net.json | 1101 ------------------- data/OS.json | 462 -------- data/Obj.json | 345 ------ data/Oo.json | 35 - data/Parsing.json | 131 --- data/Pervasives.json | 2061 ----------------------------------- data/Printexc.json | 98 -- data/Printf.json | 147 --- data/Queue.json | 199 ---- data/Random.json | 283 ----- data/Regexp.json | 284 ----- data/Scanf.json | 343 ------ data/Set.json | 48 - data/Sort.json | 55 - data/Stack.json | 136 --- data/Std_exit.json | 12 - data/Str.json | 445 -------- data/Stream.json | 170 --- data/String.json | 342 ------ data/Sys.json | 50 - data/Ulexing.json | 436 -------- data/Utf16.json | 283 ----- data/Utf8.json | 130 --- data/Weak.json | 166 --- data/index.json | 249 ----- 66 files changed, 22226 deletions(-) delete mode 100644 data/Array.json delete mode 100644 data/Base64.json delete mode 100644 data/Bitstring.json delete mode 100644 data/Bitstring_config.json delete mode 100644 data/Bitstring_types.json delete mode 100644 data/Block.json delete mode 100644 data/Buffer.json delete mode 100644 data/Callback.json delete mode 100644 data/CamlinternalLazy.json delete mode 100644 data/CamlinternalMod.json delete mode 100644 data/CamlinternalOO.json delete mode 100644 data/Char.json delete mode 100644 data/Complex.json delete mode 100644 data/Cow.json delete mode 100644 data/Digest.json delete mode 100644 data/Dns.json delete mode 100644 data/Dyntype.json delete mode 100644 data/Format.json delete mode 100644 data/Gc.json delete mode 100644 data/Hashtbl.json delete mode 100644 data/Http.json delete mode 100644 data/Int32.json delete mode 100644 data/Int64.json delete mode 100644 data/Lazy.json delete mode 100644 data/Lexing.json delete mode 100644 data/List.json delete mode 100644 data/Log.json delete mode 100644 data/Lwt.json delete mode 100644 data/Lwt_condition.json delete mode 100644 data/Lwt_list.json delete mode 100644 data/Lwt_mutex.json delete mode 100644 data/Lwt_mvar.json delete mode 100644 data/Lwt_pool.json delete mode 100644 data/Lwt_pqueue.json delete mode 100644 data/Lwt_sequence.json delete mode 100644 data/Lwt_stream.json delete mode 100644 data/Lwt_switch.json delete mode 100644 data/Lwt_util.json delete mode 100644 data/Map.json delete mode 100644 data/Marshal.json delete mode 100644 data/Nativeint.json delete mode 100644 data/Net.json delete mode 100644 data/OS.json delete mode 100644 data/Obj.json delete mode 100644 data/Oo.json delete mode 100644 data/Parsing.json delete mode 100644 data/Pervasives.json delete mode 100644 data/Printexc.json delete mode 100644 data/Printf.json delete mode 100644 data/Queue.json delete mode 100644 data/Random.json delete mode 100644 data/Regexp.json delete mode 100644 data/Scanf.json delete mode 100644 data/Set.json delete mode 100644 data/Sort.json delete mode 100644 data/Stack.json delete mode 100644 data/Std_exit.json delete mode 100644 data/Str.json delete mode 100644 data/Stream.json delete mode 100644 data/String.json delete mode 100644 data/Sys.json delete mode 100644 data/Ulexing.json delete mode 100644 data/Utf16.json delete mode 100644 data/Utf8.json delete mode 100644 data/Weak.json delete mode 100644 data/index.json diff --git a/data/Array.json b/data/Array.json deleted file mode 100644 index 2d74ef5..0000000 --- a/data/Array.json +++ /dev/null @@ -1,351 +0,0 @@ -{ "module": - { "name": "Array", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|0" }, - "info": - { "description": "Array operations." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Array.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|973" }, - "info": - { "description": "Return the length (number of elements) of the given array." }, - "type": "'a array -> int", - "params": [ - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|1092" }, - "info": - { "description": "Array.get a n returns the element number n of array a. The first element has number 0. The last element has number Array.length a - 1. You can also write a.(n) instead of Array.get a n.

Raise Invalid_argument \"index out of bounds\" if n is outside the range 0 to (Array.length a - 1)." }, - "type": "'a array -> int -> 'a", - "params": [ - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Array.set", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|1475" }, - "info": - { "description": "Array.set a n x modifies array a in place, replacing element number n with x. You can also write a.(n) <- x instead of Array.set a n x.

Raise Invalid_argument \"index out of bounds\" if n is outside the range 0 to Array.length a - 1." }, - "type": "'a array -> int -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Array.make", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|1811" }, - "info": - { "description": "Array.make n x returns a fresh array of length n, initialized with x. All the elements of this new array are initially physically equal to x (in the sense of the == predicate). Consequently, if x is mutable, it is shared among all elements of the array, and modifying x through one of the array entries will modify all other entries at the same time.

Raise Invalid_argument if n < 0 or n > Sys.max_array_length. If the value of x is a floating-point number, then the maximum size is only Sys.max_array_length / 2." }, - "type": "int -> 'a -> 'a array", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Array.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|2441" }, - "info": - { "deprecated": "Array.create is an alias for Array.make." }, - "type": "int -> 'a -> 'a array", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Array.init", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|2566" }, - "info": - { "description": "Array.init n f returns a fresh array of length n, with element number i initialized to the result of f i. In other terms, Array.init n f tabulates the results of f applied to the integers 0 to n-1.

Raise Invalid_argument if n < 0 or n > Sys.max_array_length. If the return type of f is float, then the maximum size is only Sys.max_array_length / 2." }, - "type": "int -> (int -> 'a) -> 'a array", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int -> 'a" } ] } }, - { "value": - { "name": "Array.make_matrix", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|3011" }, - "info": - { "description": "Array.make_matrix dimx dimy e returns a two-dimensional array (an array of arrays) with first dimension dimx and second dimension dimy. All the elements of this new matrix are initially physically equal to e. The element (x,y) of a matrix m is accessed with the notation m.(x).(y).

Raise Invalid_argument if dimx or dimy is negative or greater than Sys.max_array_length. If the value of e is a floating-point number, then the maximum size is only Sys.max_array_length / 2." }, - "type": "int -> int -> 'a -> 'a array array", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Array.create_matrix", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|3599" }, - "info": - { "deprecated": "Array.create_matrix is an alias for Array.make_matrix." }, - "type": "int -> int -> 'a -> 'a array array", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Array.append", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|3734" }, - "info": - { "description": "Array.append v1 v2 returns a fresh array containing the concatenation of the arrays v1 and v2." }, - "type": "'a array -> 'a array -> 'a array", - "params": [ - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.concat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|3892" }, - "info": - { "description": "Same as Array.append, but concatenates a list of arrays." }, - "type": "'a array list -> 'a array", - "params": [ - { "name": "", - "type": "'a array list" } ] } }, - { "value": - { "name": "Array.sub", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|3998" }, - "info": - { "description": "Array.sub a start len returns a fresh array of length len, containing the elements number start to start + len - 1 of array a.

Raise Invalid_argument \"Array.sub\" if start and len do not designate a valid subarray of a; that is, if start < 0, or len < 0, or start + len > Array.length a." }, - "type": "'a array -> int -> int -> 'a array", - "params": [ - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Array.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|4378" }, - "info": - { "description": "Array.copy a returns a copy of a, that is, a fresh array containing the same elements as a." }, - "type": "'a array -> 'a array", - "params": [ - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.fill", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|4519" }, - "info": - { "description": "Array.fill a ofs len x modifies the array a in place, storing x in elements number ofs to ofs + len - 1.

Raise Invalid_argument \"Array.fill\" if ofs and len do not designate a valid subarray of a." }, - "type": "'a array -> int -> int -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Array.blit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|4799" }, - "info": - { "description": "Array.blit v1 o1 v2 o2 len copies len elements from array v1, starting at element number o1, to array v2, starting at element number o2. It works correctly even if v1 and v2 are the same array, and the source and destination chunks overlap.

Raise Invalid_argument \"Array.blit\" if o1 and len do not designate a valid subarray of v1, or if o2 and len do not designate a valid subarray of v2." }, - "type": "'a array -> int -> 'a array -> int -> int -> unit", - "params": [ - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Array.to_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|5310" }, - "info": - { "description": "Array.to_list a returns the list of all the elements of a." }, - "type": "'a array -> 'a list", - "params": [ - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.of_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|5415" }, - "info": - { "description": "Array.of_list l returns a fresh array containing the elements of l." }, - "type": "'a list -> 'a array", - "params": [ - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Array.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|5532" }, - "info": - { "description": "Array.iter f a applies function f in turn to all the elements of a. It is equivalent to f a.(0); f a.(1); ...; f a.(Array.length a - 1); ()." }, - "type": "('a -> unit) -> 'a array -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|5740" }, - "info": - { "description": "Array.map f a applies function f to all the elements of a, and builds an array with the results returned by f: [| f a.(0); f a.(1); ...; f a.(Array.length a - 1) |]." }, - "type": "('a -> 'b) -> 'a array -> 'b array", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.iteri", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|5975" }, - "info": - { "description": "Same as Array.iter, but the function is applied to the index of the element as first argument, and the element itself as second argument." }, - "type": "(int -> 'a -> unit) -> 'a array -> unit", - "params": [ - { "name": "", - "type": "int -> 'a -> unit" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.mapi", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|6182" }, - "info": - { "description": "Same as Array.map, but the function is applied to the index of the element as first argument, and the element itself as second argument." }, - "type": "(int -> 'a -> 'b) -> 'a array -> 'b array", - "params": [ - { "name": "", - "type": "int -> 'a -> 'b" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.fold_left", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|6389" }, - "info": - { "description": "Array.fold_left f x a computes f (... (f (f x a.(0)) a.(1)) ...) a.(n-1), where n is the length of the array a." }, - "type": "('a -> 'b -> 'a) -> 'a -> 'b array -> 'a", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'a" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.fold_right", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|6580" }, - "info": - { "description": "Array.fold_right f a x computes f a.(0) (f a.(1) ( ... (f a.(n-1) x) ...)), where n is the length of the array a." }, - "type": "('a -> 'b -> 'b) -> 'a array -> 'b -> 'b", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'b" }, - { "name": "", - "type": "'a array" }, - { "name": "", - "type": "'a" } ] } }, - { "comment": "
Sorting
" }, - { "value": - { "name": "Array.sort", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|6796" }, - "info": - { "description": "Sort an array in increasing order according to a comparison function. The comparison function must return 0 if its arguments compare as equal, a positive integer if the first is greater, and a negative integer if the first is smaller (see below for a complete specification). For example, Pervasives.compare is a suitable comparison function, provided there are no floating-point NaN values in the data. After calling Array.sort, the array is sorted in place in increasing order. Array.sort is guaranteed to run in constant heap space and (at most) logarithmic stack space.

The current implementation uses Heap Sort. It runs in constant stack space.

Specification of the comparison function: Let a be the array and cmp the comparison function. The following must be true for all x, y, z in a : When Array.sort returns, a contains the same elements as before, reordered in such a way that for all i and j valid indices of a :" }, - "type": "('a -> 'a -> int) -> 'a array -> unit", - "params": [ - { "name": "", - "type": "'a -> 'a -> int" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.stable_sort", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|8008" }, - "info": - { "description": "Same as Array.sort, but the sorting algorithm is stable (i.e. elements that compare equal are kept in their original order) and not guaranteed to run in constant heap space.

The current implementation uses Merge Sort. It uses n/2 words of heap space, where n is the length of the array. It is usually faster than the current implementation of Array.sort." }, - "type": "('a -> 'a -> int) -> 'a array -> unit", - "params": [ - { "name": "", - "type": "'a -> 'a -> int" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Array.fast_sort", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/array.mli|8453" }, - "info": - { "description": "Same as Array.sort or Array.stable_sort, whichever is faster on typical input." }, - "type": "('a -> 'a -> int) -> 'a array -> unit", - "params": [ - { "name": "", - "type": "'a -> 'a -> int" }, - { "name": "", - "type": "'a array" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Base64.json b/data/Base64.json deleted file mode 100644 index 1ca1f0f..0000000 --- a/data/Base64.json +++ /dev/null @@ -1,34 +0,0 @@ -{ "module": - { "name": "Base64", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/base64.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/base64.mli|0" }, - "info": - { "description": "decode a string encoded in base64. Will leave trailing NULLs on the string padding it out to a multiple of 3 characters" }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Base64.decode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/base64.mli|715" }, - "info": "", - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Base64.encode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/base64.mli|780" }, - "info": - { "description": "encode a string into base64" }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Bitstring.json b/data/Bitstring.json deleted file mode 100644 index e1574f2..0000000 --- a/data/Bitstring.json +++ /dev/null @@ -1,483 +0,0 @@ -{ "module": - { "name": "Bitstring", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|0" }, - "info": - { "description": "Bitstring library." }, - "type": "sig end", - "module_structure": [ - { "comment": "Jump straight to the reference section for documentation on types and functions.

Introduction



Bitstring adds Erlang-style bitstrings and matching over bitstrings as a syntax extension and library for OCaml. You can use this module to both parse and generate binary formats, for example, communications protocols, disk formats and binary files.

OCaml bitstring website

This library used to be called \"bitmatch\".

Examples



A function which can parse IPv4 packets:

let display pkt = bitmatch pkt with (* IPv4 packet header 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | 4 | IHL |Type of Service| Total Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Identification |Flags| Fragment Offset | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Time to Live | Protocol | Header Checksum | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Source Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Destination Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Options | Padding | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ) | { 4 : 4; hdrlen : 4; tos : 8; length : 16; identification : 16; flags : 3; fragoffset : 13; ttl : 8; protocol : 8; checksum : 16; source : 32; dest : 32; options : (hdrlen-5)*32 : bitstring; payload : -1 : bitstring } -> printf \"IPv4:\\n\"; printf \" header length: %d * 32 bit words\\n\" hdrlen; printf \" type of service: %d\\n\" tos; printf \" packet length: %d bytes\\n\" length; printf \" identification: %d\\n\" identification; printf \" flags: %d\\n\" flags; printf \" fragment offset: %d\\n\" fragoffset; printf \" ttl: %d\\n\" ttl; printf \" protocol: %d\\n\" protocol; printf \" checksum: %d\\n\" checksum; printf \" source: %lx dest: %lx\\n\" source dest; printf \" header options + padding:\\n\"; Bitstring.hexdump_bitstring stdout options; printf \" packet payload:\\n\"; Bitstring.hexdump_bitstring stdout payload | { version : 4 } -> eprintf \"unknown IP version %d\\n\" version; exit 1 | { _ } as pkt -> eprintf \"data is smaller than one nibble:\\n\"; Bitstring.hexdump_bitstring stderr pkt; exit 1

A program which can parse Linux EXT3 filesystem superblocks:

let bits = Bitstring.bitstring_of_file \"tests/ext3_sb\" let () = bitmatch bits with | { s_inodes_count : 32 : littleendian; (* Inodes count *) s_blocks_count : 32 : littleendian; (* Blocks count *) s_r_blocks_count : 32 : littleendian; (* Reserved blocks count *) s_free_blocks_count : 32 : littleendian; (* Free blocks count *) s_free_inodes_count : 32 : littleendian; (* Free inodes count *) s_first_data_block : 32 : littleendian; (* First Data Block *) s_log_block_size : 32 : littleendian; (* Block size *) s_log_frag_size : 32 : littleendian; (* Fragment size *) s_blocks_per_group : 32 : littleendian; (* # Blocks per group *) s_frags_per_group : 32 : littleendian; (* # Fragments per group *) s_inodes_per_group : 32 : littleendian; (* # Inodes per group *) s_mtime : 32 : littleendian; (* Mount time *) s_wtime : 32 : littleendian; (* Write time *) s_mnt_count : 16 : littleendian; (* Mount count *) s_max_mnt_count : 16 : littleendian; (* Maximal mount count *) 0xef53 : 16 : littleendian } -> (* Magic signature *) printf \"ext3 superblock:\\n\"; printf \" s_inodes_count = %ld\\n\" s_inodes_count; printf \" s_blocks_count = %ld\\n\" s_blocks_count; printf \" s_free_inodes_count = %ld\\n\" s_free_inodes_count; printf \" s_free_blocks_count = %ld\\n\" s_free_blocks_count | { _ } -> eprintf \"not an ext3 superblock!\\n%!\"; exit 2

Constructing packets for a simple binary message protocol:

(* +---------------+---------------+--------------------------+ | type | subtype | parameter | +---------------+---------------+--------------------------+ <-- 16 bits --> <-- 16 bits --> <------- 32 bits --------> All fields are in network byte order. ) let make_message typ subtype param = (BITSTRING { typ : 16; subtype : 16; param : 32 }) ;;

Loading, creating bitstrings



The basic data type is the Bitstring.bitstring, a string of bits of arbitrary length. Bitstrings can be any length in bits and operations do not need to be byte-aligned (although they will generally be more efficient if they are byte-aligned).

Internally a bitstring is stored as a normal OCaml string together with an offset and length, where the offset and length are measured in bits. Thus one can efficiently form substrings of bitstrings, overlay a bitstring on existing data, and load and save bitstrings from files or other external sources.

To load a bitstring from a file use bitstring_of_file or Bitstring.bitstring_of_chan.

There are also functions to create bitstrings from arbitrary data. See the reference below.

Matching bitstrings with patterns



Use the bitmatch operator (part of the syntax extension) to break apart a bitstring into its fields. bitmatch works a lot like the OCaml match operator.

The general form of bitmatch is:

bitmatch bitstring-expression with

| { pattern } -> code

| { pattern } -> code

| ...

As with normal match, the statement attempts to match the bitstring against each pattern in turn. If none of the patterns match then the standard library Match_failure exception is thrown.

Patterns look a bit different from normal match patterns. They consist of a list of bitfields separated by ; where each bitfield contains a bind variable, the width (in bits) of the field, and other information. Some example patterns:

bitmatch bits with | { version : 8; name : 8; param : 8 } -> ... (* Bitstring of at least 3 bytes. First byte is the version number, second byte is a field called name, third byte is a field called parameter. *) | { flag : 1 } -> printf \"flag is %b\\n\" flag (* A single flag bit (mapped into an OCaml boolean). *) | { len : 4; data : 1+len } -> printf \"len = %d, data = 0x%Lx\\n\" len data (* A 4-bit length, followed by 1-16 bits of data, where the length of the data is computed from len. *) | { ipv6_source : 128 : bitstring; ipv6_dest : 128 : bitstring } -> ... (* IPv6 source and destination addresses. Each is 128 bits and is mapped into a bitstring type which will be a substring of the main bitstring expression. *)

You can also add conditional when-clauses:

| { version : 4 } when version = 4 || version = 6 -> ... (* Only match and run the code when version is 4 or 6. If it isn't we will drop through to the next case. *)

Note that the pattern is only compared against the first part of the bitstring (there may be more data in the bitstring following the pattern, which is not matched). In terms of regular expressions you might say that the pattern matches ^pattern, not ^pattern$. To ensure that the bitstring contains only the pattern, add a length -1 bitstring to the end and test that its length is zero in the when-clause:

| { n : 4; rest : -1 : bitstring } when Bitstring.bitstring_length rest = 0 -> ... (* Only matches exactly 4 bits. *)

Normally the first part of each field is a binding variable, but you can also match a constant, as in:

| { (4|6) : 4 } -> ... (* Only matches if the first 4 bits contain either the integer 4 or the integer 6. *)

One may also match on strings:

| { \"MAGIC\" : 5*8 : string } -> ... (* Only matches if the string \"MAGIC\" appears at the start of the input. *)

Pattern field reference



The exact format of each pattern field is:

pattern : length [: qualifier [,qualifier ...]]

pattern is the pattern, binding variable name, or constant to match. length is the length in bits which may be either a constant or an expression. The length expression is just an OCaml expression and can use any values defined in the program, and refer back to earlier fields (but not to later fields).

Integers can only have lengths in the range [1..64] bits. See the integer types section below for how these are mapped to the OCaml int/int32/int64 types. This is checked at compile time if the length expression is constant, otherwise it is checked at runtime and you will get a runtime exception eg. in the case of a computed length expression.

A bitstring field of length -1 matches all the rest of the bitstring (thus this is only useful as the last field in a pattern).

A bitstring field of length 0 matches an empty bitstring (occasionally useful when matching optional subfields).

Qualifiers are a list of identifiers/expressions which control the type, signedness and endianness of the field. Permissible qualifiers are:

The default settings are int, unsigned, bigendian, no offset.

Note that many of these qualifiers cannot be used together, eg. bitstrings do not have endianness. The syntax extension should give you a compile-time error if you use incompatible qualifiers.

Other cases in bitmatch



As well as a list of fields, it is possible to name the bitstring and/or have a default match case:

| { _ } -> ... (* Default match case. *) | { _ } as pkt -> ... (* Default match case, with 'pkt' bound to the whole bitstring. *)

Constructing bitstrings



Bitstrings may be constructed using the BITSTRING operator (as an expression). The BITSTRING operator takes a list of fields, similar to the list of fields for matching:

let version = 1 ;; let data = 10 ;; let bits = BITSTRING { version : 4; data : 12 } ;; (* Constructs a 16-bit bitstring with the first four bits containing the integer 1, and the following 12 bits containing the integer 10, arranged in network byte order. *) Bitstring.hexdump_bitstring stdout bits ;; (* Prints: 00000000 10 0a |.. | )

The format of each field is the same as for pattern fields (see Pattern field reference section), and things like computed length fields, fixed value fields, insertion of bitstrings within bitstrings, etc. are all supported.

Construction exception



The BITSTRING operator may throw a Bitstring.Construct_failure exception at runtime.

Runtime errors include:

Integer types



Integer types are mapped to OCaml types bool, int, int32 or int64 using a system which tries to ensure that (a) the types are reasonably predictable and (b) the most efficient type is preferred.

The rules are slightly different depending on whether the bit length expression in the field is a compile-time constant or a computed expression.

Detection of compile-time constants is quite simplistic so only simple integer literals and simple expressions (eg. 5*8) are recognized as constants.

In any case the bit size of an integer is limited to the range [1..64]. This is detected as a compile-time error if that is possible, otherwise a runtime check is added which can throw an Invalid_argument exception.

The mapping is thus:

Bit size\t ---- OCaml type ---- Constant\tComputed expression 1\t\tbool\t\tint64 2..31\tint\t\tint64 32\t\tint32\t\tint64 33..64\tint64\t\tint64

A possible future extension may allow people with 64 bit computers to specify a more optimal int type for bit sizes in the range 32..63. If this was implemented then such code could not even be compiled on 32 bit platforms, so it would limit portability.

Another future extension may be to allow computed expressions to assert min/max range for the bit size, allowing a more efficient data type than int64 to be used. (Of course under such circumstances there would still need to be a runtime check to enforce the size).

Advanced pattern-matching features



Computed offsets



You can add an offset(..) qualifier to bitmatch patterns in order to move the current offset within the bitstring forwards.

For example:

bitmatch bits with | { field1 : 8; field2 : 8 : offset(160) } -> ...

matches field1 at the start of the bitstring and field2 at 160 bits into the bitstring. The middle 152 bits go unmatched (ie. can be anything).

The generated code is efficient. If field lengths and offsets are known to be constant at compile time, then almost all runtime checks are avoided. Non-constant field lengths and/or non-constant offsets can result in more runtime checks being added.

Note that moving the offset backwards, and moving the offset in BITSTRING constructors, are both not supported at present.

Check expressions



You can add a check(expr) qualifier to bitmatch patterns. If the expression evaluates to false then the current match case fails to match (in other words, we fall through to the next match case - there is no error).

For example: bitmatch bits with | { field : 16 : check (field > 100) } -> ...

Note the difference between a check expression and a when-clause is that the when-clause is evaluated after all the fields have been matched. On the other hand a check expression is evaluated after the individual field has been matched, which means it is potentially more efficient (if the check expression fails then we don't waste any time matching later fields).

We wanted to use the notation when(expr) here, but because when is a reserved word we could not do this.

Bind expressions



A bind expression is used to change the value of a matched field. For example: bitmatch bits with | { len : 16 : bind (len * 8); field : len : bitstring } -> ...

In the example, after 'len' has been matched, its value would be multiplied by 8, so the width of 'field' is the matched value multiplied by 8.

In the general case: | { field : ... : bind (expr) } -> ... evaluates the following after the field has been matched: let field = expr in (* remaining fields *)

Order of evaluation of check() and bind()



The choice is arbitrary, but we have chosen that check expressions are evaluated first, and bind expressions are evaluated after.

This means that the result of bind() is not available in the check expression.

Note that this rule applies regardless of the order of check() and bind() in the source code.

save_offset_to



Use save_offset_to(variable) to save the current bit offset within the match to a variable (strictly speaking, to a pattern). This variable is then made available in any check() and bind() clauses in the current field, and to any later fields, and to the code after the ->.

For example: bitmatch bits with | { len : 16; _ : len : bitstring; field : 16 : save_offset_to (field_offset) } -> printf \"field is at bit offset %d in the match\\n\" field_offset

(In that example, field_offset should always have the value len+16).

Named patterns and persistent patterns



Please see Bitstring_persistent for documentation on this subject.

Compiling



Using the compiler directly you can do:

ocamlc -I +bitstring \\ -pp \"camlp4of bitstring.cma bitstring_persistent.cma \\ `ocamlc -where`/bitstring/pa_bitstring.cmo\" \\ unix.cma bitstring.cma test.ml -o test

Simpler method using findlib:

ocamlfind ocamlc \\ -package bitstring,bitstring.syntax -syntax bitstring.syntax \\ -linkpkg test.ml -o test

Security and type safety



Security on input



The main concerns for input are buffer overflows and denial of service.

It is believed that this library is robust against attempted buffer overflows. In addition to OCaml's normal bounds checks, we check that field lengths are >= 0, and many additional checks.

Denial of service attacks are more problematic. We only work forwards through the bitstring, thus computation will eventually terminate. As for computed lengths, code such as this is thought to be secure:

bitmatch bits with | { len : 64; buffer : Int64.to_int len : bitstring } ->

The len field can be set arbitrarily large by an attacker, but when pattern-matching against the buffer field this merely causes a test such as if len <= remaining_size to fail. Even if the length is chosen so that buffer bitstring is allocated, the allocation of sub-bitstrings is efficient and doesn't involve an arbitary-sized allocation or any copying.

However the above does not necessarily apply to strings used in matching, since they may cause the library to use the Bitstring.string_of_bitstring function, which allocates a string. So you should take care if you use the string type particularly with a computed length that is derived from external input.

The main protection against attackers should be to ensure that the main program will only read input bitstrings up to a certain length, which is outside the scope of this library.

Security on output



As with the input side, computed lengths are believed to be safe. For example:

let len = read_untrusted_source () in let buffer = allocate_bitstring () in BITSTRING { buffer : len : bitstring }

This code merely causes a check that buffer's length is the same as len. However the program function allocate_bitstring must refuse to allocate an oversized buffer (but that is outside the scope of this library).

Order of evaluation



In bitmatch statements, fields are evaluated left to right.

Note that the when-clause is evaluated last, so if you are relying on the when-clause to filter cases then your code may do a lot of extra and unncessary pattern-matching work on fields which may never be needed just to evaluate the when-clause. Either rearrange the code to do only the first part of the match, followed by the when-clause, followed by a second inner bitmatch, or use a check() qualifier within fields.

Safety



The current implementation is believed to be fully type-safe, and makes compile and run-time checks where appropriate. If you find a case where a check is missing please submit a bug report or a patch.

Limits



These are thought to be the current limits:

Integers: [1..64] bits.

Bitstrings (32 bit platforms): maximum length is limited by the string size, ie. 16 MBytes.

Bitstrings (64 bit platforms): maximum length is thought to be limited by the string size, ie. effectively unlimited.

Bitstrings must be loaded into memory before we can match against them. Thus available memory may be considered a limit for some applications.

Reference

Types

" }, - { "type": - { "name": "Bitstring.endian", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|22192" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "BigEndian", - "type": [ ] }, - { "name": "LittleEndian", - "type": [ ] }, - { "name": "NativeEndian", - "type": [ ] } ] } } }, - { "value": - { "name": "Bitstring.string_of_endian", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|22242" }, - "info": - { "description": "Endianness." }, - "type": "Bitstring.endian -> string", - "params": [ - { "name": "", - "type": "Bitstring.endian" } ] } }, - { "type": - { "name": "Bitstring.bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|22307" }, - "info": - { "description": "bitstring is the basic type used to store bitstrings.

The type contains the underlying data (a string), the current bit offset within the string and the current bit length of the string (counting from the bit offset). Note that the offset and length are in bits, not bytes.

Normally you don't need to use the bitstring type directly, since there are functions and syntax extensions which hide the details.

See also Bitstring.bitstring_of_string, bitstring_of_file, Bitstring.hexdump_bitstring, Bitstring.bitstring_length." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string * int * int" } }, - { "type": - { "name": "Bitstring.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|22905" }, - "info": - { "description": "t is a synonym for the Bitstring.bitstring type.

This allows you to use this module with functors like Set and Map from the stdlib." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Bitstring.bitstring" } }, - { "comment": "

Exceptions

" }, - { "exception": - { "name": "Bitstring.Construct_failure", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|23090" }, - "info": - { "description": "Construct_failure (message, file, line, char) may be raised by the BITSTRING constructor.

Common reasons are that values are out of range of the fields that contain them, or that computed lengths are impossible (eg. negative length bitfields).

message is the error message.

file, line and char point to the original source location of the BITSTRING constructor that failed." }, - "exception_args": [ "string", "string", "int", "int" ] } }, - { "comment": "

Bitstring comparison

" }, - { "value": - { "name": "Bitstring.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|23609" }, - "info": - { "description": "compare bs1 bs2 compares two bitstrings and returns zero if they are equal, a negative number if bs1 < bs2, or a positive number if bs1 > bs2.

This tests \"semantic equality\" which is not affected by the offset or alignment of the underlying representation (see Bitstring.bitstring).

The ordering is total and lexicographic." }, - "type": "Bitstring.bitstring -> Bitstring.bitstring -> int", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Bitstring.equals", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|24010" }, - "info": - { "description": "equals returns true if and only if the two bitstrings are semantically equal. It is the same as calling compare and testing if the result is 0, but usually more efficient." }, - "type": "Bitstring.bitstring -> Bitstring.bitstring -> bool", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "comment": "

Bitstring manipulation

" }, - { "value": - { "name": "Bitstring.bitstring_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|24284" }, - "info": - { "description": "bitstring_length bitstring returns the length of the bitstring in bits.

Note this just returns the third field in the Bitstring.bitstring tuple." }, - "type": "Bitstring.bitstring -> int", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Bitstring.subbitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|24481" }, - "info": - { "description": "subbitstring bits off len returns a sub-bitstring of the bitstring, starting at offset off bits and with length len bits.

If the original bitstring is not long enough to do this then the function raises Invalid_argument \"subbitstring\".

Note that this function just changes the offset and length fields of the Bitstring.bitstring tuple, so is very efficient." }, - "type": "Bitstring.bitstring -> int -> int -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.dropbits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|24930" }, - "info": - { "description": "Drop the first n bits of the bitstring and return a new bitstring which is shorter by n bits.

If the length of the original bitstring is less than n bits, this raises Invalid_argument \"dropbits\".

Note that this function just changes the offset and length fields of the Bitstring.bitstring tuple, so is very efficient." }, - "type": "int -> Bitstring.bitstring -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Bitstring.takebits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|25318" }, - "info": - { "description": "Take the first n bits of the bitstring and return a new bitstring which is exactly n bits long.

If the length of the original bitstring is less than n bits, this raises Invalid_argument \"takebits\".

Note that this function just changes the offset and length fields of the Bitstring.bitstring tuple, so is very efficient." }, - "type": "int -> Bitstring.bitstring -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Bitstring.concat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|25708" }, - "info": - { "description": "Concatenate a list of bitstrings together into a single bitstring." }, - "type": "Bitstring.bitstring list -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "Bitstring.bitstring list" } ] } }, - { "comment": "

Constructing bitstrings

" }, - { "value": - { "name": "Bitstring.empty_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|25864" }, - "info": - { "description": "empty_bitstring is the empty, zero-length bitstring." }, - "type": "Bitstring.bitstring", - "params": [ ] } }, - { "value": - { "name": "Bitstring.create_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|25959" }, - "info": - { "description": "create_bitstring n creates an n bit bitstring containing all zeroes." }, - "type": "int -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.make_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|26084" }, - "info": - { "description": "make_bitstring n c creates an n bit bitstring containing the repeated 8 bit pattern in c.

For example, make_bitstring 16 '\\x5a' will create the bitstring 0x5a5a or in binary 0101 1010 0101 1010.

Note that the length is in bits, not bytes. The length does NOT need to be a multiple of 8." }, - "type": "int -> char -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Bitstring.zeroes_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|26460" }, - "info": - { "description": "zeroes_bitstring creates an n bit bitstring of all 0's.

Actually this is the same as Bitstring.create_bitstring." }, - "type": "int -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.ones_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|26623" }, - "info": - { "description": "ones_bitstring creates an n bit bitstring of all 1's." }, - "type": "int -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.bitstring_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|26727" }, - "info": - { "description": "bitstring_of_string str creates a bitstring of length String.length str * 8 (bits) containing the bits in str.

Note that the bitstring uses str as the underlying string (see the representation of Bitstring.bitstring) so you should not change str after calling this." }, - "type": "string -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Bitstring.bitstring_of_chan", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|27071" }, - "info": - { "description": "bitstring_of_chan chan loads the contents of the input channel chan as a bitstring.

The length of the final bitstring is determined by the remaining input in chan, but will always be a multiple of 8 bits.

See also Bitstring.bitstring_of_chan_max." }, - "type": "Pervasives.in_channel -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Bitstring.bitstring_of_chan_max", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|27395" }, - "info": - { "description": "bitstring_of_chan_max chan max works like Bitstring.bitstring_of_chan but will only read up to max bytes from the channel (or fewer if the end of input occurs before that)." }, - "type": "Pervasives.in_channel -> int -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" }, - { "name": "", - "type": "int" } ] } }, - { "comment": "

Converting bitstrings

" }, - { "value": - { "name": "Bitstring.string_of_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|27678" }, - "info": - { "description": "string_of_bitstring bitstring converts a bitstring to a string (eg. to allow comparison).

This function is inefficient. In the best case when the bitstring is nicely byte-aligned we do a String.sub operation. If the bitstring isn't aligned then this involves a lot of bit twiddling and is particularly inefficient.

If the bitstring is not a multiple of 8 bits wide then the final byte of the string contains the high bits set to the remaining bits and the low bits set to 0." }, - "type": "Bitstring.bitstring -> string", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Bitstring.bitstring_to_chan", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|28247" }, - "info": - { "description": "bitstring_to_file bits filename writes the bitstring bits to the channel chan.

Channels are made up of bytes, bitstrings can be any bit length including fractions of bytes. So this function only works if the length of the bitstring is an exact multiple of 8 bits (otherwise it raises Invalid_argument \"bitstring_to_chan\").

Furthermore the function is efficient only in the case where the bitstring is stored fully aligned, otherwise it has to do inefficient bit twiddling like Bitstring.string_of_bitstring.

In the common case where the bitstring was generated by the BITSTRING operator and is an exact multiple of 8 bits wide, then this function will always work efficiently." }, - "type": "Bitstring.bitstring -> Pervasives.out_channel -> unit", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "comment": "

Printing bitstrings

" }, - { "value": - { "name": "Bitstring.hexdump_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29072" }, - "info": - { "description": "hexdump_bitstring chan bitstring prints the bitstring to the output channel in a format similar to the Unix command hexdump -C." }, - "type": "Pervasives.out_channel -> Bitstring.bitstring -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "comment": "

Bitstring buffer

" }, - { "module": - { "name": "Bitstring.Buffer", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29306" }, - "info": - { "description": "Buffers are mainly used by the BITSTRING constructor, but may also be useful for end users. They work much like the standard library Buffer module." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Bitstring.Buffer.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29333" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Bitstring.Buffer.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29337" }, - "info": "", - "type": "unit -> Bitstring.Buffer.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Bitstring.Buffer.contents", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29362" }, - "info": "", - "type": "Bitstring.Buffer.t -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "Bitstring.Buffer.t" } ] } }, - { "value": - { "name": "Bitstring.Buffer.add_bits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29394" }, - "info": "", - "type": "Bitstring.Buffer.t -> string -> int -> unit", - "params": [ - { "name": "", - "type": "Bitstring.Buffer.t" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.Buffer.add_bit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29438" }, - "info": "", - "type": "Bitstring.Buffer.t -> bool -> unit", - "params": [ - { "name": "", - "type": "Bitstring.Buffer.t" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Bitstring.Buffer.add_byte", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|29472" }, - "info": "", - "type": "Bitstring.Buffer.t -> int -> unit", - "params": [ - { "name": "", - "type": "Bitstring.Buffer.t" }, - { "name": "", - "type": "int" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "comment": "

Get/set bits



These functions let you manipulate individual bits in the bitstring. However they are not particularly efficient and you should generally use the bitmatch and BITSTRING operators when building and parsing bitstrings.

These functions all raise Invalid_argument \"index out of bounds\" if the index is out of range of the bitstring." }, - { "value": - { "name": "Bitstring.set", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30064" }, - "info": - { "description": "set bits n sets the nth bit in the bitstring to 1." }, - "type": "Bitstring.bitstring -> int -> unit", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.clear", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30164" }, - "info": - { "description": "clear bits n sets the nth bit in the bitstring to 0." }, - "type": "Bitstring.bitstring -> int -> unit", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.is_set", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30268" }, - "info": - { "description": "is_set bits n is true if the nth bit is set to 1." }, - "type": "Bitstring.bitstring -> int -> bool", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.is_clear", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30370" }, - "info": - { "description": "is_clear bits n is true if the nth bit is set to 0." }, - "type": "Bitstring.bitstring -> int -> bool", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.put", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30476" }, - "info": - { "description": "put bits n v sets the nth bit in the bitstring to 1 if v is not zero, or to 0 if v is zero." }, - "type": "Bitstring.bitstring -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Bitstring.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30634" }, - "info": - { "description": "get bits n returns the nth bit (returns non-zero or 0)." }, - "type": "Bitstring.bitstring -> int -> int", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" }, - { "name": "", - "type": "int" } ] } }, - { "comment": "

Miscellaneous

" }, - { "value": - { "name": "Bitstring.package", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30764" }, - "info": - { "description": "The package name, always \"ocaml-bitstring\"" }, - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Bitstring.version", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30838" }, - "info": - { "description": "The package version as a string." }, - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Bitstring.debug", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring.mli|30900" }, - "info": - { "description": "Set this variable to true to enable extended debugging. This only works if debugging was also enabled in the pa_bitstring.ml file at compile time, otherwise it does nothing." }, - "type": "bool Pervasives.ref", - "params": [ ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "OS", "Net", "Block", "Dns", "Http" ] } } } \ No newline at end of file diff --git a/data/Bitstring_config.json b/data/Bitstring_config.json deleted file mode 100644 index 2504ee3..0000000 --- a/data/Bitstring_config.json +++ /dev/null @@ -1,52 +0,0 @@ -{ "module": - { "name": "Bitstring_config", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_config.ml", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_config.ml|0", - "interface": "unknown" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Bitstring_config.nativeendian", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_config.ml|1133", - "interface": "unknown" }, - "info": "", - "type": "Bitstring_types.endian", - "params": [ ] } }, - { "value": - { "name": "Bitstring_config.package", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_config.ml|1182", - "interface": "unknown" }, - "info": "", - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Bitstring_config.version", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_config.ml|1214", - "interface": "unknown" }, - "info": "", - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Bitstring_config.ocamllibdir", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_config.ml|1236", - "interface": "unknown" }, - "info": "", - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Bitstring_config.diff", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_config.ml|1272", - "interface": "unknown" }, - "info": "", - "type": "string", - "params": [ ] } } ], - "dependencies": - { "uses": [ "Bitstring_types" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Bitstring_types.json b/data/Bitstring_types.json deleted file mode 100644 index 29b8fb6..0000000 --- a/data/Bitstring_types.json +++ /dev/null @@ -1,40 +0,0 @@ -{ "module": - { "name": "Bitstring_types", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_types.ml", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_types.ml|0", - "interface": "unknown" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Bitstring_types.endian", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_types.ml|963", - "interface": "unknown" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "BigEndian", - "type": [ ] }, - { "name": "LittleEndian", - "type": [ ] }, - { "name": "NativeEndian", - "type": [ ] } ] } } }, - { "value": - { "name": "Bitstring_types.string_of_endian", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/bitstring_types.ml|1013", - "interface": "unknown" }, - "info": "", - "type": "Bitstring_types.endian -> string", - "params": [ - { "tuple": - { "type": "Bitstring_types.endian", - "contents": [ ] } } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Bitstring_config" ] } } } \ No newline at end of file diff --git a/data/Block.json b/data/Block.json deleted file mode 100644 index debb220..0000000 --- a/data/Block.json +++ /dev/null @@ -1,170 +0,0 @@ -{ "module": - { "name": "Block", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Block.Manager", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "exception": - { "name": "Block.Manager.Error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|23" }, - "info": "", - "exception_args": [ "string" ] } }, - { "module": - { "name": "Block.Manager.Unix", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|49" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Block.Manager.Unix.fd", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|75" }, - "info": "", - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" } ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "Block.Manager.Unix.resp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|90" }, - "info": "", - "params": [ - { "covariant": "true", - "contravariant": "false", - "type": "'b" } ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "OK", - "type": [ "'a" ] }, - { "name": "Err", - "type": [ "string" ] }, - { "name": "Retry", - "type": [ ] } ] } } }, - { "value": - { "name": "Block.Manager.Unix.file_open_readonly", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|138" }, - "info": "", - "type": "string -> [ `ro_file ] Block.Manager.Unix.fd Block.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Block.Manager.Unix.read", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|231" }, - "info": "", - "type": "[ `ro_file ] Block.Manager.Unix.fd ->\n string -> int -> int -> int Block.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `ro_file ] Block.Manager.Unix.fd" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Block.Manager.Unix.close", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|324" }, - "info": "", - "type": "[ `ro_file ] Block.Manager.Unix.fd -> unit", - "params": [ - { "name": "", - "type": "[ `ro_file ] Block.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Block.Manager.Unix.iobind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|391" }, - "info": "", - "type": "('a -> 'b Block.Manager.Unix.resp) -> 'a -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Block.Manager.Unix.resp" }, - { "name": "", - "type": "'a" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Block.RO", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|446" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Block.RO.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|469" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "exception": - { "name": "Block.RO.Error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|472" }, - "info": "", - "exception_args": [ "string" ] } }, - { "value": - { "name": "Block.RO.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|499" }, - "info": "", - "type": "OS.Blkif.t -> Block.RO.t Lwt.t", - "params": [ - { "name": "", - "type": "OS.Blkif.t" } ] } }, - { "value": - { "name": "Block.RO.read", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/block.mli|534" }, - "info": "", - "type": "Block.RO.t -> string -> Bitstring.t Lwt_stream.t Lwt.t", - "params": [ - { "name": "", - "type": "Block.RO.t" }, - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ "OS", "Lwt_stream", "Lwt", "Bitstring" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Buffer.json b/data/Buffer.json deleted file mode 100644 index a8e8cfc..0000000 --- a/data/Buffer.json +++ /dev/null @@ -1,197 +0,0 @@ -{ "module": - { "name": "Buffer", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|0" }, - "info": - { "description": "Extensible string buffers.

This module implements string buffers that automatically expand as necessary. It provides accumulative concatenation of strings in quasi-linear time (instead of quadratic time when strings are concatenated pairwise)." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Buffer.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|1220" }, - "info": - { "description": "The abstract type of buffers." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Buffer.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|1260" }, - "info": - { "description": "create n returns a fresh buffer, initially empty. The n parameter is the initial size of the internal string that holds the buffer contents. That string is automatically reallocated when more than n characters are stored in the buffer, but shrinks back to n characters when reset is called. For best performance, n should be of the same order of magnitude as the number of characters that are expected to be stored in the buffer (for instance, 80 for a buffer that holds one output line). Nothing bad will happen if the buffer grows beyond that limit, however. In doubt, take n = 16 for instance. If n is not between 1 and Sys.max_string_length, it will be clipped to that interval." }, - "type": "int -> Buffer.t", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Buffer.contents", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|2026" }, - "info": - { "description": "Return a copy of the current contents of the buffer. The buffer itself is unchanged." }, - "type": "Buffer.t -> string", - "params": [ - { "name": "", - "type": "Buffer.t" } ] } }, - { "value": - { "name": "Buffer.sub", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|2149" }, - "info": - { "description": "Buffer.sub b off len returns (a copy of) the substring of the current contents of the buffer b starting at offset off of length len bytes. May raise Invalid_argument if out of bounds request. The buffer itself is unaffected." }, - "type": "Buffer.t -> int -> int -> string", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Buffer.blit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|2428" }, - "info": - { "description": "Buffer.blit src srcoff dst dstoff len copies len characters from the current contents of the buffer src, starting at offset srcoff to string dst, starting at character dstoff.

Raise Invalid_argument if srcoff and len do not designate a valid substring of src, or if dstoff and len do not designate a valid substring of dst.", - "since": "3.11.2" }, - "type": "Buffer.t -> int -> string -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Buffer.nth", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|2871" }, - "info": - { "description": "get the n-th character of the buffer. Raise Invalid_argument if index out of bounds" }, - "type": "Buffer.t -> int -> char", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Buffer.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|2992" }, - "info": - { "description": "Return the number of characters currently contained in the buffer." }, - "type": "Buffer.t -> int", - "params": [ - { "name": "", - "type": "Buffer.t" } ] } }, - { "value": - { "name": "Buffer.clear", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|3089" }, - "info": - { "description": "Empty the buffer." }, - "type": "Buffer.t -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" } ] } }, - { "value": - { "name": "Buffer.reset", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|3137" }, - "info": - { "description": "Empty the buffer and deallocate the internal string holding the buffer contents, replacing it with the initial internal string of length n that was allocated by Buffer.create n. For long-lived buffers that may have grown a lot, reset allows faster reclamation of the space used by the buffer." }, - "type": "Buffer.t -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" } ] } }, - { "value": - { "name": "Buffer.add_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|3481" }, - "info": - { "description": "add_char b c appends the character c at the end of the buffer b." }, - "type": "Buffer.t -> char -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Buffer.add_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|3593" }, - "info": - { "description": "add_string b s appends the string s at the end of the buffer b." }, - "type": "Buffer.t -> string -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Buffer.add_substring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|3708" }, - "info": - { "description": "add_substring b s ofs len takes len characters from offset ofs in string s and appends them at the end of the buffer b." }, - "type": "Buffer.t -> string -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Buffer.add_substitute", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|3903" }, - "info": - { "description": "add_substitute b f s appends the string pattern s at the end of the buffer b with substitution. The substitution process looks for variables into the pattern and substitutes each variable name by its value, as obtained by applying the mapping f to the variable name. Inside the string pattern, a variable name immediately follows a non-escaped $ character and is one of the following:" }, - "type": "Buffer.t -> (string -> string) -> string -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "string -> string" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Buffer.add_buffer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/buffer.mli|4768" }, - "info": - { "description": "add_buffer b1 b2 appends the current contents of buffer b2 at the end of buffer b1. b2 is not modified." }, - "type": "Buffer.t -> Buffer.t -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "Buffer.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Format", "Printf", "Utf8", "Utf16", "Cow" ] } } } \ No newline at end of file diff --git a/data/Callback.json b/data/Callback.json deleted file mode 100644 index 13884df..0000000 --- a/data/Callback.json +++ /dev/null @@ -1,39 +0,0 @@ -{ "module": - { "name": "Callback", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/callback.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/callback.mli|0" }, - "info": - { "description": "Registering Caml values with the C runtime.

This module allows Caml values to be registered with the C runtime under a symbolic name, so that C code can later call back registered Caml functions, or raise registered Caml exceptions." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Callback.register", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/callback.mli|1201" }, - "info": - { "description": "Callback.register n v registers the value v under the name n. C code can later retrieve a handle to v by calling caml_named_value(n)." }, - "type": "string -> 'a -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Callback.register_exception", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/callback.mli|1395" }, - "info": - { "description": "Callback.register_exception n exn registers the exception contained in the exception value exn under the name n. C code can later retrieve a handle to the exception by calling caml_named_value(n). The exception value thus obtained is suitable for passign as first argument to raise_constant or raise_with_arg." }, - "type": "string -> exn -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "exn" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/CamlinternalLazy.json b/data/CamlinternalLazy.json deleted file mode 100644 index 7f3774b..0000000 --- a/data/CamlinternalLazy.json +++ /dev/null @@ -1,58 +0,0 @@ -{ "module": - { "name": "CamlinternalLazy", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalLazy.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalLazy.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "exception": - { "name": "CamlinternalLazy.Undefined", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalLazy.mli|996" }, - "info": "" } }, - { "value": - { "name": "CamlinternalLazy.force_lazy_block", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalLazy.mli|1019" }, - "info": "", - "type": "'a lazy_t -> 'a", - "params": [ - { "name": "", - "type": "'a lazy_t" } ] } }, - { "value": - { "name": "CamlinternalLazy.force_val_lazy_block", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalLazy.mli|1062" }, - "info": "", - "type": "'a lazy_t -> 'a", - "params": [ - { "name": "", - "type": "'a lazy_t" } ] } }, - { "value": - { "name": "CamlinternalLazy.force", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalLazy.mli|1109" }, - "info": "", - "type": "'a lazy_t -> 'a", - "params": [ - { "name": "", - "type": "'a lazy_t" } ] } }, - { "value": - { "name": "CamlinternalLazy.force_val", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalLazy.mli|1140" }, - "info": "", - "type": "'a lazy_t -> 'a", - "params": [ - { "name": "", - "type": "'a lazy_t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/CamlinternalMod.json b/data/CamlinternalMod.json deleted file mode 100644 index 8f7c0a3..0000000 --- a/data/CamlinternalMod.json +++ /dev/null @@ -1,64 +0,0 @@ -{ "module": - { "name": "CamlinternalMod", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalMod.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalMod.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "CamlinternalMod.shape", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalMod.mli|961" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Function", - "type": [ ] }, - { "name": "Lazy", - "type": [ ] }, - { "name": "Class", - "type": [ ] }, - { "name": "Module", - "type": [ "CamlinternalMod.shape array" ] } ] } } }, - { "value": - { "name": "CamlinternalMod.init_mod", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalMod.mli|1028" }, - "info": "", - "type": "string * int * int -> CamlinternalMod.shape -> Obj.t", - "params": [ - { "tuple": - { "type": "string * int * int", - "contents": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "name": "", - "type": "CamlinternalMod.shape" } ] } }, - { "value": - { "name": "CamlinternalMod.update_mod", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalMod.mli|1079" }, - "info": "", - "type": "CamlinternalMod.shape -> Obj.t -> Obj.t -> unit", - "params": [ - { "name": "", - "type": "CamlinternalMod.shape" }, - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "Obj.t" } ] } } ], - "dependencies": - { "uses": [ "Obj" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/CamlinternalOO.json b/data/CamlinternalOO.json deleted file mode 100644 index 0ad6080..0000000 --- a/data/CamlinternalOO.json +++ /dev/null @@ -1,629 +0,0 @@ -{ "module": - { "name": "CamlinternalOO", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|0" }, - "info": - { "description": "Run-time support for objects and classes. All functions in this module are for system use only, not for the casual user." }, - "type": "sig end", - "module_structure": [ - { "comment": "
Classes
" }, - { "type": - { "name": "CamlinternalOO.tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1119" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "CamlinternalOO.label", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1128" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "CamlinternalOO.table", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1139" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "CamlinternalOO.meth", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1150" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "CamlinternalOO.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1160" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "CamlinternalOO.obj", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1167" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "CamlinternalOO.closure", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1176" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "CamlinternalOO.public_method_label", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1184" }, - "info": "", - "type": "string -> CamlinternalOO.tag", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "CamlinternalOO.new_method", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1224" }, - "info": "", - "type": "CamlinternalOO.table -> CamlinternalOO.label", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.new_variable", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1256" }, - "info": "", - "type": "CamlinternalOO.table -> string -> int", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "CamlinternalOO.new_methods_variables", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1298" }, - "info": "", - "type": "CamlinternalOO.table ->\n string array -> string array -> CamlinternalOO.label array", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string array" }, - { "name": "", - "type": "string array" } ] } }, - { "value": - { "name": "CamlinternalOO.get_variable", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1383" }, - "info": "", - "type": "CamlinternalOO.table -> string -> int", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "CamlinternalOO.get_variables", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1425" }, - "info": "", - "type": "CamlinternalOO.table -> string array -> int array", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string array" } ] } }, - { "value": - { "name": "CamlinternalOO.get_method_label", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1480" }, - "info": "", - "type": "CamlinternalOO.table -> string -> CamlinternalOO.label", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "CamlinternalOO.get_method_labels", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1528" }, - "info": "", - "type": "CamlinternalOO.table -> string array -> CamlinternalOO.label array", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string array" } ] } }, - { "value": - { "name": "CamlinternalOO.get_method", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1589" }, - "info": "", - "type": "CamlinternalOO.table -> CamlinternalOO.label -> CamlinternalOO.meth", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "CamlinternalOO.label" } ] } }, - { "value": - { "name": "CamlinternalOO.set_method", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1629" }, - "info": "", - "type": "CamlinternalOO.table -> CamlinternalOO.label -> CamlinternalOO.meth -> unit", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "CamlinternalOO.label" }, - { "name": "", - "type": "CamlinternalOO.meth" } ] } }, - { "value": - { "name": "CamlinternalOO.set_methods", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1677" }, - "info": "", - "type": "CamlinternalOO.table -> CamlinternalOO.label array -> unit", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "CamlinternalOO.label array" } ] } }, - { "value": - { "name": "CamlinternalOO.narrow", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1724" }, - "info": "", - "type": "CamlinternalOO.table -> string array -> string array -> string array -> unit", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string array" }, - { "name": "", - "type": "string array" }, - { "name": "", - "type": "string array" } ] } }, - { "value": - { "name": "CamlinternalOO.widen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1799" }, - "info": "", - "type": "CamlinternalOO.table -> unit", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.add_initializer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1825" }, - "info": "", - "type": "CamlinternalOO.table -> (CamlinternalOO.obj -> unit) -> unit", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "CamlinternalOO.obj -> unit" } ] } }, - { "value": - { "name": "CamlinternalOO.dummy_table", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1878" }, - "info": "", - "type": "CamlinternalOO.table", - "params": [ ] } }, - { "value": - { "name": "CamlinternalOO.create_table", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1902" }, - "info": "", - "type": "string array -> CamlinternalOO.table", - "params": [ - { "name": "", - "type": "string array" } ] } }, - { "value": - { "name": "CamlinternalOO.init_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1943" }, - "info": "", - "type": "CamlinternalOO.table -> unit", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.inherits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|1974" }, - "info": "", - "type": "CamlinternalOO.table ->\n string array ->\n string array ->\n string array ->\n CamlinternalOO.t * (CamlinternalOO.table -> CamlinternalOO.obj -> Obj.t) *\n CamlinternalOO.t * CamlinternalOO.obj -> bool -> Obj.t array", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" }, - { "name": "", - "type": "string array" }, - { "name": "", - "type": "string array" }, - { "name": "", - "type": "string array" }, - { "tuple": - { "type": "CamlinternalOO.t * (CamlinternalOO.table -> CamlinternalOO.obj -> Obj.t) *\n CamlinternalOO.t * CamlinternalOO.obj", - "contents": [ - { "name": "", - "type": "CamlinternalOO.t" }, - { "name": "", - "type": "CamlinternalOO.table -> CamlinternalOO.obj -> Obj.t" }, - { "name": "", - "type": "CamlinternalOO.t" }, - { "name": "", - "type": "CamlinternalOO.obj" } ] } }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "CamlinternalOO.make_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2117" }, - "info": "", - "type": "string array ->\n (CamlinternalOO.table -> Obj.t -> CamlinternalOO.t) ->\n CamlinternalOO.t * (CamlinternalOO.table -> Obj.t -> CamlinternalOO.t) *\n (Obj.t -> CamlinternalOO.t) * Obj.t", - "params": [ - { "name": "", - "type": "string array" }, - { "name": "", - "type": "CamlinternalOO.table -> Obj.t -> CamlinternalOO.t" } ] } }, - { "type": - { "name": "CamlinternalOO.init_table", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2239" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "CamlinternalOO.make_class_store", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2250" }, - "info": "", - "type": "string array ->\n (CamlinternalOO.table -> CamlinternalOO.t) ->\n CamlinternalOO.init_table -> unit", - "params": [ - { "name": "", - "type": "string array" }, - { "name": "", - "type": "CamlinternalOO.table -> CamlinternalOO.t" }, - { "name": "", - "type": "CamlinternalOO.init_table" } ] } }, - { "value": - { "name": "CamlinternalOO.dummy_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2328" }, - "info": "", - "type": "string * int * int ->\n CamlinternalOO.t * (CamlinternalOO.table -> Obj.t -> CamlinternalOO.t) *\n (Obj.t -> CamlinternalOO.t) * Obj.t", - "params": [ - { "tuple": - { "type": "string * int * int", - "contents": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } } ] } }, - { "comment": "
Objects
" }, - { "value": - { "name": "CamlinternalOO.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2448" }, - "info": "", - "type": "(< .. > as 'a) -> 'a", - "params": [ - { "name": "", - "type": "< .. >" } ] } }, - { "value": - { "name": "CamlinternalOO.create_object", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2480" }, - "info": "", - "type": "CamlinternalOO.table -> CamlinternalOO.obj", - "params": [ - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.create_object_opt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2513" }, - "info": "", - "type": "CamlinternalOO.obj -> CamlinternalOO.table -> CamlinternalOO.obj", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.run_initializers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2557" }, - "info": "", - "type": "CamlinternalOO.obj -> CamlinternalOO.table -> unit", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.run_initializers_opt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2601" }, - "info": "", - "type": "CamlinternalOO.obj ->\n CamlinternalOO.obj -> CamlinternalOO.table -> CamlinternalOO.obj", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.create_object_and_run_initializers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2655" }, - "info": "", - "type": "CamlinternalOO.obj -> CamlinternalOO.table -> CamlinternalOO.obj", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.table" } ] } }, - { "value": - { "name": "CamlinternalOO.send", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2716" }, - "info": "", - "type": "CamlinternalOO.obj -> CamlinternalOO.tag -> CamlinternalOO.t", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.tag" } ] } }, - { "value": - { "name": "CamlinternalOO.sendcache", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2758" }, - "info": "", - "type": "CamlinternalOO.obj ->\n CamlinternalOO.tag -> CamlinternalOO.t -> int -> CamlinternalOO.t", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.tag" }, - { "name": "", - "type": "CamlinternalOO.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "CamlinternalOO.sendself", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2822" }, - "info": "", - "type": "CamlinternalOO.obj -> CamlinternalOO.label -> CamlinternalOO.t", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.label" } ] } }, - { "value": - { "name": "CamlinternalOO.get_public_method", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2874" }, - "info": "", - "type": "CamlinternalOO.obj -> CamlinternalOO.tag -> CamlinternalOO.closure", - "params": [ - { "name": "", - "type": "CamlinternalOO.obj" }, - { "name": "", - "type": "CamlinternalOO.tag" } ] } }, - { "comment": "
Table cache
" }, - { "type": - { "name": "CamlinternalOO.tables", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|2996" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "CamlinternalOO.lookup_tables", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|3003" }, - "info": "", - "type": "CamlinternalOO.tables ->\n CamlinternalOO.closure array -> CamlinternalOO.tables", - "params": [ - { "name": "", - "type": "CamlinternalOO.tables" }, - { "name": "", - "type": "CamlinternalOO.closure array" } ] } }, - { "comment": "
Builtins to reduce code size
" }, - { "type": - { "name": "CamlinternalOO.impl", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|4229" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "GetConst", - "type": [ ] }, - { "name": "GetVar", - "type": [ ] }, - { "name": "GetEnv", - "type": [ ] }, - { "name": "GetMeth", - "type": [ ] }, - { "name": "SetVar", - "type": [ ] }, - { "name": "AppConst", - "type": [ ] }, - { "name": "AppVar", - "type": [ ] }, - { "name": "AppEnv", - "type": [ ] }, - { "name": "AppMeth", - "type": [ ] }, - { "name": "AppConstConst", - "type": [ ] }, - { "name": "AppConstVar", - "type": [ ] }, - { "name": "AppConstEnv", - "type": [ ] }, - { "name": "AppConstMeth", - "type": [ ] }, - { "name": "AppVarConst", - "type": [ ] }, - { "name": "AppEnvConst", - "type": [ ] }, - { "name": "AppMethConst", - "type": [ ] }, - { "name": "MethAppConst", - "type": [ ] }, - { "name": "MethAppVar", - "type": [ ] }, - { "name": "MethAppEnv", - "type": [ ] }, - { "name": "MethAppMeth", - "type": [ ] }, - { "name": "SendConst", - "type": [ ] }, - { "name": "SendVar", - "type": [ ] }, - { "name": "SendEnv", - "type": [ ] }, - { "name": "SendMeth", - "type": [ ] }, - { "name": "Closure", - "type": [ "CamlinternalOO.closure" ] } ] } } }, - { "comment": "
Parameters
" }, - { "type": - { "name": "CamlinternalOO.params", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|4648" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "compact_table", - "mutable": true, - "type": "bool" }, - { "name": "copy_parent", - "mutable": true, - "type": "bool" }, - { "name": "clean_when_copying", - "mutable": true, - "type": "bool" }, - { "name": "retry_count", - "mutable": true, - "type": "int" }, - { "name": "bucket_small_size", - "mutable": true, - "type": "int" } ] } } }, - { "value": - { "name": "CamlinternalOO.params", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|4832" }, - "info": "", - "type": "CamlinternalOO.params", - "params": [ ] } }, - { "comment": "
Statistics
" }, - { "type": - { "name": "CamlinternalOO.stats", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|4881" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "classes", - "mutable": false, - "type": "int" }, - { "name": "methods", - "mutable": false, - "type": "int" }, - { "name": "inst_vars", - "mutable": false, - "type": "int" } ] } } }, - { "value": - { "name": "CamlinternalOO.stats", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/camlinternalOO.mli|4949" }, - "info": "", - "type": "unit -> CamlinternalOO.stats", - "params": [ - { "name": "", - "type": "unit" } ] } } ], - "dependencies": - { "uses": [ "Obj" ], - "used_by": [ "Oo" ] } } } \ No newline at end of file diff --git a/data/Char.json b/data/Char.json deleted file mode 100644 index a6df6b9..0000000 --- a/data/Char.json +++ /dev/null @@ -1,92 +0,0 @@ -{ "module": - { "name": "Char", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|0" }, - "info": - { "description": "Character operations." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Char.code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|976" }, - "info": - { "description": "Return the ASCII code of the argument." }, - "type": "char -> int", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Char.chr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|1065" }, - "info": - { "description": "Return the character with the given ASCII code. Raise Invalid_argument \"Char.chr\" if the argument is outside the range 0--255." }, - "type": "int -> char", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Char.escaped", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|1230" }, - "info": - { "description": "Return a string representing the given character, with special characters escaped following the lexical conventions of Objective Caml." }, - "type": "char -> string", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Char.lowercase", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|1408" }, - "info": - { "description": "Convert the given character to its equivalent lowercase character." }, - "type": "char -> char", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Char.uppercase", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|1512" }, - "info": - { "description": "Convert the given character to its equivalent uppercase character." }, - "type": "char -> char", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "type": - { "name": "Char.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|1621" }, - "info": - { "description": "An alias for the type of characters." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "char" } }, - { "value": - { "name": "Char.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/char.mli|1675" }, - "info": - { "description": "The comparison function for characters, with the same specification as Pervasives.compare. Along with the type t, this function compare allows the module Char to be passed as argument to the functors Set.Make and Map.Make." }, - "type": "Char.t -> Char.t -> int", - "params": [ - { "name": "", - "type": "Char.t" }, - { "name": "", - "type": "Char.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Complex.json b/data/Complex.json deleted file mode 100644 index 6f90e34..0000000 --- a/data/Complex.json +++ /dev/null @@ -1,235 +0,0 @@ -{ "module": - { "name": "Complex", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|0" }, - "info": - { "description": "Complex numbers.

This module provides arithmetic operations on complex numbers. Complex numbers are represented by their real and imaginary parts (cartesian representation). Each part is represented by a double-precision floating-point number (type float)." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Complex.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1241" }, - "info": - { "description": "The type of complex numbers. re is the real part and im the imaginary part." }, - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "re", - "mutable": false, - "type": "float" }, - { "name": "im", - "mutable": false, - "type": "float" } ] } } }, - { "value": - { "name": "Complex.zero", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1363" }, - "info": - { "description": "The complex number 0." }, - "type": "Complex.t", - "params": [ ] } }, - { "value": - { "name": "Complex.one", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1407" }, - "info": - { "description": "The complex number 1." }, - "type": "Complex.t", - "params": [ ] } }, - { "value": - { "name": "Complex.i", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1450" }, - "info": - { "description": "The complex number i." }, - "type": "Complex.t", - "params": [ ] } }, - { "value": - { "name": "Complex.neg", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1491" }, - "info": - { "description": "Unary negation." }, - "type": "Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.conj", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1531" }, - "info": - { "description": "Conjugate: given the complex x + i.y, returns x - i.y." }, - "type": "Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.add", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1615" }, - "info": - { "description": "Addition" }, - "type": "Complex.t -> Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" }, - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.sub", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1653" }, - "info": - { "description": "Subtraction" }, - "type": "Complex.t -> Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" }, - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.mul", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1694" }, - "info": - { "description": "Multiplication" }, - "type": "Complex.t -> Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" }, - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.inv", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1738" }, - "info": - { "description": "Multiplicative inverse (1/z)." }, - "type": "Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.div", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1794" }, - "info": - { "description": "Division" }, - "type": "Complex.t -> Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" }, - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.sqrt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|1832" }, - "info": - { "description": "Square root. The result x + i.y is such that x > 0 or x = 0 and y >= 0. This function has a discontinuity along the negative real axis." }, - "type": "Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.norm2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|2010" }, - "info": - { "description": "Norm squared: given x + i.y, returns x^2 + y^2." }, - "type": "Complex.t -> float", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.norm", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|2092" }, - "info": - { "description": "Norm: given x + i.y, returns sqrt(x^2 + y^2)." }, - "type": "Complex.t -> float", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.arg", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|2171" }, - "info": - { "description": "Argument. The argument of a complex number is the angle in the complex plane between the positive real axis and a line passing through zero and the number. This angle ranges from -pi to pi. This function has a discontinuity along the negative real axis." }, - "type": "Complex.t -> float", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.polar", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|2476" }, - "info": - { "description": "polar norm arg returns the complex having norm norm and argument arg." }, - "type": "float -> float -> Complex.t", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Complex.exp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|2595" }, - "info": - { "description": "Exponentiation. exp z returns e to the z power." }, - "type": "Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.log", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|2674" }, - "info": - { "description": "Natural logarithm (in base e)." }, - "type": "Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" } ] } }, - { "value": - { "name": "Complex.pow", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/complex.mli|2731" }, - "info": - { "description": "Power function. pow z1 z2 returns z1 to the z2 power." }, - "type": "Complex.t -> Complex.t -> Complex.t", - "params": [ - { "name": "", - "type": "Complex.t" }, - { "name": "", - "type": "Complex.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Cow.json b/data/Cow.json deleted file mode 100644 index 2b10f82..0000000 --- a/data/Cow.json +++ /dev/null @@ -1,1342 +0,0 @@ -{ "module": - { "name": "Cow", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|0" }, - "info": - { "description": "Streaming XML IO.

A well-formed sequence of signals represents an XML document tree traversal in depth first order (this has nothing to do with XML well-formedness). Input pulls a well-formed sequence of signals from a data source and output pushes a well-formed sequence of signals to a data destination. Functions are provided to easily transform sequences of signals to/from arborescent data structures.

Consult the features and limitations and examples of use.

Version 1.0.2 - daniel.buenzl i@erratique.ch

References.

Tim Bray. The annotated XML Specification, 1998.

Tim Bray et al. Namespaces in XML 1.1 (2nd ed.), 2006.

Basic types and values

" }, - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Cow.Xml", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Streaming XML IO.

A well-formed sequence of signals represents an XML document tree traversal in depth first order (this has nothing to do with XML well-formedness). Input pulls a well-formed sequence of signals from a data source and output pushes a well-formed sequence of signals to a data destination. Functions are provided to easily transform sequences of signals to/from arborescent data structures.

Consult the features and limitations and examples of use.

Version 1.0.2 - daniel.buenzl i@erratique.ch

References.

Tim Bray. The annotated XML Specification, 1998.

Tim Bray et al. Namespaces in XML 1.1 (2nd ed.), 2006.

Basic types and values

" }, - { "type": - { "name": "Cow.Xml.encoding", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|1090" }, - "info": - { "description": "The type for character encodings. For `UTF_16, endianness is determined from the BOM." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `ISO_8859_1 | `US_ASCII | `UTF_16 | `UTF_16BE | `UTF_16LE | `UTF_8 ]" } }, - { "type": - { "name": "Cow.Xml.dtd", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|1313" }, - "info": - { "description": "The type for the optional DTD." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string option" } }, - { "type": - { "name": "Cow.Xml.name", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|1426" }, - "info": - { "description": "The type for attribute and element's expanded names (uri,local). An empty uri represents a name without a namespace name, i.e. an unprefixed name that is not under the scope of a default namespace." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string * string" } }, - { "type": - { "name": "Cow.Xml.attribute", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|1732" }, - "info": - { "description": "The type for attributes. Name and attribute data." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Cow.Xml.name * string" } }, - { "type": - { "name": "Cow.Xml.tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|1821" }, - "info": - { "description": "The type for an element tag. Tag name and attribute list." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Cow.Xml.name * Cow.Xml.attribute list" } }, - { "type": - { "name": "Cow.Xml.signal", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|1920" }, - "info": - { "description": "The type for signals. A well-formed sequence of signals belongs to the language of the doc grammar : doc ::= `Dtd tree tree ::= `El_start child `El_end child ::= `Data | tree | epsilon Input and output deal only with well-formed sequences or exceptions are raised." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Data of string\n | `Dtd of Cow.Xml.dtd\n | `El_end\n | `El_start of Cow.Xml.tag\n | `Raw of string ]" } }, - { "value": - { "name": "Cow.Xml.ns_xml", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|2311" }, - "info": - { "description": "Namespace name value bound to the reserved \"xml\" prefix." }, - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Cow.Xml.ns_xmlns", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|2445" }, - "info": - { "description": "Namespace name value bound to the reserved \"xmlns\" prefix." }, - "type": "string", - "params": [ ] } }, - { "comment": "

Input

" }, - { "type": - { "name": "Cow.Xml.pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|2598" }, - "info": - { "description": "The type for input positions. Line and column number, both start with 1." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int * int" } }, - { "type": - { "name": "Cow.Xml.error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|2739" }, - "info": - { "description": "The type for input errors." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Expected_char_seqs of string list * string\n | `Expected_root_element\n | `Illegal_char_ref of string\n | `Illegal_char_seq of string\n | `Malformed_char_stream\n | `Max_buffer_size\n | `Unexpected_eoi\n | `Unknown_encoding of string\n | `Unknown_entity_ref of string\n | `Unknown_ns_prefix of string ]" } }, - { "value": - { "name": "Cow.Xml.error_message", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|3555" }, - "info": - { "description": "Converts the error to an english error message." }, - "type": "Cow.Xml.error -> string", - "params": [ - { "name": "", - "type": "Cow.Xml.error" } ] } }, - { "exception": - { "name": "Cow.Xml.Error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|3647" }, - "info": - { "description": "Raised on input errors." }, - "exception_args": [ "Cow.Xml.pos", "Cow.Xml.error" ] } }, - { "type": - { "name": "Cow.Xml.source", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|3715" }, - "info": - { "description": "The type for input sources. For `String starts reading at the given integer position. For `Fun the function must return the next byte as an int and raise End_of_file if there is no such byte." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Fun of unit -> int | `String of int * string ]" } }, - { "type": - { "name": "Cow.Xml.input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|4008" }, - "info": - { "description": "The type for input abstractions." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Cow.Xml.make_input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|4055" }, - "info": - { "description": "Returns a new input abstraction reading from the given source. " }, - "type": "?templates:bool ->\n ?enc:Cow.Xml.encoding option ->\n ?strip:bool ->\n ?ns:(string -> string option) ->\n ?entity:(string -> string option) -> Cow.Xml.source -> Cow.Xml.input", - "params": [ - { "name": "templates", - "type": "bool option" }, - { "name": "enc", - "type": "Cow.Xml.encoding option option" }, - { "name": "strip", - "type": "bool option" }, - { "name": "ns", - "type": "(string -> string option) option" }, - { "name": "entity", - "type": "(string -> string option) option" }, - { "name": "", - "type": "Cow.Xml.source" } ] } }, - { "value": - { "name": "Cow.Xml.input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|4768" }, - "info": - { "description": "Inputs a signal. Repeated invocation of the function with the same input abstraction will generate a well-formed sequence of signals or an Cow.Xml.Error is raised. Furthermore there will be no two consecutive `Data signals in the sequence and their string is always non empty. After a well-formed sequence was input another may be input, see Cow.Xml.eoi and details.

Raises Cow.Xml.Error on input errors." }, - "type": "Cow.Xml.input -> Cow.Xml.signal", - "params": [ - { "name": "", - "type": "Cow.Xml.input" } ] } }, - { "value": - { "name": "Cow.Xml.input_tree", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|5252" }, - "info": - { "description": "If the next signal is a :

Raises Cow.Xml.Error on input errors and Invalid_argument if the next signal is not `El_start or `Data." }, - "type": "el:(Cow.Xml.tag -> 'a list -> 'a) ->\n data:(string -> 'a) -> Cow.Xml.input -> 'a", - "params": [ - { "name": "el", - "type": "Cow.Xml.tag -> 'a list -> 'a" }, - { "name": "data", - "type": "string -> 'a" }, - { "name": "", - "type": "Cow.Xml.input" } ] } }, - { "value": - { "name": "Cow.Xml.input_doc_tree", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|6125" }, - "info": - { "description": "Same as Cow.Xml.input_tree but reads a complete well-formed sequence of signals.

Raises Cow.Xml.Error on input errors and Invalid_argument if the next signal is not `Dtd." }, - "type": "el:(Cow.Xml.tag -> 'a list -> 'a) ->\n data:(string -> 'a) -> Cow.Xml.input -> Cow.Xml.dtd * 'a", - "params": [ - { "name": "el", - "type": "Cow.Xml.tag -> 'a list -> 'a" }, - { "name": "data", - "type": "string -> 'a" }, - { "name": "", - "type": "Cow.Xml.input" } ] } }, - { "value": - { "name": "Cow.Xml.peek", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|6454" }, - "info": - { "description": "Same as Cow.Xml.input but doesn't remove the signal from the sequence.

Raises Cow.Xml.Error on input errors." }, - "type": "Cow.Xml.input -> Cow.Xml.signal", - "params": [ - { "name": "", - "type": "Cow.Xml.input" } ] } }, - { "value": - { "name": "Cow.Xml.eoi", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|6598" }, - "info": - { "description": "Returns true if the end of input is reached. See details.

Raises Cow.Xml.Error on input errors." }, - "type": "Cow.Xml.input -> bool", - "params": [ - { "name": "", - "type": "Cow.Xml.input" } ] } }, - { "value": - { "name": "Cow.Xml.pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|6743" }, - "info": - { "description": "Current position in the input abstraction." }, - "type": "Cow.Xml.input -> Cow.Xml.pos", - "params": [ - { "name": "", - "type": "Cow.Xml.input" } ] } }, - { "comment": "

Output

" }, - { "type": - { "name": "Cow.Xml.frag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|6841" }, - "info": - { "description": "The type for deconstructing data structures of type 'a." }, - "params": [ - { "covariant": "true", - "contravariant": "false", - "type": "'a" } ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Data of string | `El of Cow.Xml.tag * 'a list ]" } }, - { "type": - { "name": "Cow.Xml.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|6966" }, - "info": - { "description": "The type for XML fragments" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "('a Cow.Xml.frag as 'a) Cow.Xml.frag list" } }, - { "type": - { "name": "Cow.Xml.dest", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|7038" }, - "info": - { "description": "The type for output destinations. For `Buffer, the buffer won't be cleared. For `Fun the function is called with the output bytes as ints." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Buffer of Buffer.t | `Fun of int -> unit ]" } }, - { "type": - { "name": "Cow.Xml.output", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|7278" }, - "info": - { "description": "The type for output abstractions." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Cow.Xml.make_output", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|7327" }, - "info": - { "description": "Returns a new output abstraction writing to the given destination. " }, - "type": "?nl:bool ->\n ?indent:int option ->\n ?ns_prefix:(string -> string option) -> Cow.Xml.dest -> Cow.Xml.output", - "params": [ - { "name": "nl", - "type": "bool option" }, - { "name": "indent", - "type": "int option option" }, - { "name": "ns_prefix", - "type": "(string -> string option) option" }, - { "name": "", - "type": "Cow.Xml.dest" } ] } }, - { "value": - { "name": "Cow.Xml.output", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|7883" }, - "info": - { "description": "Outputs a signal. After a well-formed sequence of signals was output a new well-formed sequence can be output.

Raises Invalid_argument if the resulting signal sequence on the output abstraction is not well-formed or if a namespace name could not be bound to a prefix." }, - "type": "Cow.Xml.output -> Cow.Xml.signal -> unit", - "params": [ - { "name": "", - "type": "Cow.Xml.output" }, - { "name": "", - "type": "Cow.Xml.signal" } ] } }, - { "value": - { "name": "Cow.Xml.output_tree", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|8237" }, - "info": - { "description": "Outputs signals corresponding to a value by recursively applying the given value deconstructor.

Raises see Cow.Xml.output." }, - "type": "('a -> 'a Cow.Xml.frag) -> Cow.Xml.output -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a -> 'a Cow.Xml.frag" }, - { "name": "", - "type": "Cow.Xml.output" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Cow.Xml.output_doc_tree", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|8434" }, - "info": - { "description": "Same as Cow.Xml.output_tree but outputs a complete well-formed sequence of signals.

Raises see Cow.Xml.output." }, - "type": "('a -> 'a Cow.Xml.frag) -> Cow.Xml.output -> Cow.Xml.dtd * 'a -> unit", - "params": [ - { "name": "", - "type": "'a -> 'a Cow.Xml.frag" }, - { "name": "", - "type": "Cow.Xml.output" }, - { "tuple": - { "type": "Cow.Xml.dtd * 'a", - "contents": [ - { "name": "", - "type": "Cow.Xml.dtd" }, - { "name": "", - "type": "'a" } ] } } ] } }, - { "comment": "

Functorial interface



Cow.Xml.Make allows client to specify types for strings and internal buffers. Among other things this can be used to perform hash-consing or to process the character stream, e.g. to normalize unicode characters or to convert to a custom encoding." }, - { "type": - { "name": "Cow.Xml.std_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|8948" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string" } }, - { "type": - { "name": "Cow.Xml.std_buffer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|8973" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Buffer.t" } }, - { "module_type": - { "name": "Cow.Xml.XMLString", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|9032" }, - "info": - { "description": "Input signature for strings." }, - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Cow.Xml.XMLBuffer", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|10071" }, - "info": - { "description": "Input signature for internal buffers." }, - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Cow.Xml.S", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|10811" }, - "info": - { "description": "Output signature of Cow.Xml.Make." }, - "type": "sig end", - "kind": "" } }, - { "module": - { "name": "Cow.Xml.Make", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|12952" }, - "info": - { "description": "Functor building streaming XML IO with the given strings and buffers." }, - "type": "functor (String : XMLString) -> functor (Buffer : sig end) -> sig end", - "module_functor": - { "parameter": - { "name": "String" }, - "module_functor": - { "parameter": - { "name": "Buffer" }, - "module_with": "unavailable" } }, - "dependencies": - { "uses": [ ] } } }, - { "comment": "

Features and limitations



The module assumes strings are immutable, thus strings the client gives or receives during the input and output process must not be modified.

Input

Encoding



The parser supports ASCII, US-ASCII, UTF-8, UTF-16, UTF-16LE, UTF-16BE and ISO-8559-1 (Latin-1) encoded documents. But strings returned by the library are always UTF-8 encoded (unless you use the functor).

The encoding can be specified explicitly using the optional argument enc. Otherwise the parser uses UTF-16 or UTF-8 if there is a BOM at the beginning of the document. If there is no BOM it uses the encoding specified in the XML declaration. Finally, if there is no XML declaration UTF-8 is assumed.

White space handling



The parser performs attribute data normalization on every attribute data. This means that attribute data does not have leading and trailling white space and that any white space is collapsed and transformed to a single space character (U+0020).

White space handling of character data depends on the strip argument. If strip is true, character data is treated like attribute data, white space before and after elements is removed and any white space is collapsed and transformed to a single space character (U+0020), except if the data is under the scope of a xml:space attribute whose value is preserve. If strip is false all white space data is preserved as present in the document (however all kinds of line ends are translated to the newline character (U+000A).

Namespaces



Xmlm's names are expanded names. The parser automatically handles the document's namespace declarations. Undeclared namespace prefixes can be bound via the callback ns, which must return a namespace name. If ns returns None an `Unknown_ns_prefix error is raised.

Attributes used for namespace declarations are preserved by the parser. They are in the Cow.Xml.ns_xmlns namespace. Default namespace declarations made with xmlns have the attribute name (Xmlm.ns_xmlns, \"xmlns\"). Prefix declarations have the prefix as the local name, for example xmlns:ex results in the attribute name (Xmlm.ns_xmlns, \"ex\").

Regarding constraints on the usage of the xml and xmlns prefixes by documents, the parser does not report errors on violations of the must constraints listed in this paragraph.

Character and entity references



Character references and predefined entities are automatically resolved. Other entity references can be resolved by the callback entity, which must return an UTF-8 (unless you use the functor) string corresponding to the replacement character data. The replacement data is not analysed for further references, it is added to the data as such modulo white space stripping. If entity returns None the error `Unknown_entity_ref is returned.

Sequences of documents



When a well-formed sequence of signals is input, no data is consumed beyond the closing '>' of the document's root element.

If you want to parse a document as defined in the XML specification, call Cow.Xml.eoi after a well-formed sequence of signals, it must return true. If you expect another document on the same input abstraction a new well-formed sequence of signals can be Cow.Xml.input. Use Cow.Xml.eoi to check if a document follows (this may consume data).

Invoking Cow.Xml.eoi after a well-formed sequence of signals skips whitespaces, comments and processing instructions until it gets to either an XML declaration or a DTD or the start of a new element or the end of input (in which case Cow.Xml.eoi returns true). If there is a new document but there is no XML declaration or the declaration specifies UTF-16, the same encoding as for the previous document is used.

Miscellaneous



Output

Encoding



Outputs only UTF-8 encoded documents (even if you use the functor). Strings given to output functions must be UTF-8 encoded (unless you use the functor, but you need to provide a translation), no checks are performed.

Namespaces



Xmlm's names are expanded names. Expanded names are automatically converted to qualified names by the output abstraction. There is no particular api to specify prefixes and default namespaces, the actual result depends solely on the output of attributes belonging to the Cow.Xml.ns_xmlns namespace. For example to set the default namespace of an element to http://example.org/myns, use the following attribute : (* xmlns='http://example.org/myns' *) let default_ns = (Xmlm.ns_xmlns, \"xmlns\"), \"http://example.org/myns\" To bind the prefix \"ex\" to http://example.org/ex, use the following attribute : (* xmlns:ex='http://example.org/ex' *) let ex_ns = (Xmlm.ns_xmlns, \"ex\"), \"http://example.org/ex\" Note that outputing input signals without touching namespace declaration attributes will preserve existing prefixes and bindings provided the same namespace name is not bound to different prefixes in a given context.

The callback ns_prefix of an output abstraction can be used to give a prefix to a namespace name lacking a prefix binding in the current output scope. Given a namespace name the function must return the prefix to use. Note that this will not add any namespace declaration attribute to the output. If the function returns None, Cow.Xml.output will raise Invalid_argument. The default function returns always None.

Indentation



Output can be indented by specifying the indent argument when an output abstraction is created. If indent is None (default) signal output does not introduce any extra white space. If ident is Some c, each Cow.Xml.signal is output on its own line (for empty elements `El_start and `El_end are collapsed on a single line) and nested elements are indented with c space characters.

Sequences of documents



After a well-formed sequence of signals was output, the output abstraction can be reused to output a new well-formed sequence of signals.

Miscellaneous



Tips

" }, - { "comment": "

Examples



Sequential processing



Sequential processing has the advantage that you don't need to get the whole document tree in memory to process it.

The following function reads a single document on an input channel and outputs it. let id ic oc = let i = Xmlm.make_input (`Channel ic) in let o = Xmlm.make_output (`Channel oc) in let rec pull i o depth = Xmlm.output o (Xmlm.peek i); match Xmlm.input i with | `El_start _ -> pull i o (depth + 1) | `El_end -> if depth = 1 then () else pull i o (depth - 1) | `Data _ -> pull i o depth | `Dtd _ -> assert false in Xmlm.output o (Xmlm.input i); (* `Dtd *) pull i o 0; if not (Xmlm.eoi i) then invalid_arg \"document not well-formed\" The following function reads a sequence of documents on an input channel and outputs it. let id_seq ic oc = let i = Xmlm.make_input (`Channel ic) in let o = Xmlm.make_output ~nl:true (`Channel oc) in while not (Xmlm.eoi i) do Xmlm.output o (Xmlm.input i) done The following function reads a sequence of documents on the input channel. In each document's tree it prunes non root elements whose name belongs to prune_list. let prune_docs prune_list ic oc = let i = Xmlm.make_input (`Channel ic) in let o = Xmlm.make_output ~nl:true (`Channel oc) in let copy i o = Xmlm.output o (Xmlm.input i) in let prune (name, _) = List.mem name prune_list in let rec process i o d = let rec skip i d = match Xmlm.input i with | `El_start _ -> skip i (d + 1) | `El_end -> if d = 1 then () else skip i (d - 1) | s -> skip i d in match Xmlm.peek i with | `El_start tag when prune tag -> skip i 0; process i o d | `El_start _ -> copy i o; process i o (d + 1) | `El_end -> copy i o; if d = 0 then () else process i o (d - 1) | `Data _ -> copy i o; process i o d | `Dtd _ -> assert false in let rec docs i o = copy i o; (* `Dtd *) copy i o; (* root start *) process i o 0; if Xmlm.eoi i then () else docs i o in docs i o

Tree processing



A document's sequence of signals can be easily converted to an arborescent data structure. Assume your trees are defined by : type tree = E of Xmlm.tag * tree list | D of string The following functions input/output xml documents from/to abstractions as value of type tree. let in_tree i = let el tag childs = E (tag, childs) in let data d = D d in Xmlm.input_doc_tree ~el ~data i let out_tree o t = let frag = function | E (tag, childs) -> `El (tag, childs) | D d -> `Data d in Xmlm.output_doc_tree frag o t

Tabular data processing



We show how to process XML data that represents tabular data (some people like do that).

The file we need to deal with represents nominal data about W3C bureaucrats. There are no namespaces and attributes are ignored. The element structure of the document is :

In OCaml we represent a W3C bureaucrat by this type : type w3c_bureaucrat = { name : string; surname : string; honest : bool; obfuscation_level : float; trs : string list; } The following functions input and output W3C bureaucrats as lists of values of type w3c_bureaucrat. let in_w3c_bureaucrats src = let i = Xmlm.make_input ~strip:true src in let tag n = (\"\", n), [] in let error () = invalid_arg \"parse error\" in let accept s i = if Xmlm.input i = s then () else error () in let rec i_seq el acc i = match Xmlm.peek i with | `El_start _ -> i_seq el ((el i) :: acc) i | `El_end -> List.rev acc | _ -> error () in let i_el n i = accept (`El_start (tag n)) i; let d = match Xmlm.peek i with | `Data d -> ignore (Xmlm.input i); d | `El_end -> \"\" | _ -> error () in accept (`El_end) i; d in let i_bureaucrat i = try accept (`El_start (tag \"bureaucrat\")) i; let name = i_el \"name\" i in let surname = i_el \"surname\" i in let honest = match Xmlm.peek i with | `El_start ((\"\", \"honest\"), []) -> ignore (i_el \"honest\" i); true | _ -> false in let obf = float_of_string (i_el \"obfuscation_level\" i) in let trs = i_seq (i_el \"tr\") [] i in accept (`El_end) i; { name = name; surname = surname; honest = honest; obfuscation_level = obf; trs = trs } with | Failure _ -> error () (* float_of_string *) in accept (`Dtd None) i; accept (`El_start (tag \"list\")) i; let bl = i_seq i_bureaucrat [] i in accept (`El_end) i; if not (Xmlm.eoi i) then invalid_arg \"more than one document\"; bl let out_w3c_bureaucrats dst bl = let tag n = (\"\", n), [] in let o = Xmlm.make_output ~nl:true ~indent:(Some 2) dst in let out = Xmlm.output o in let o_el n d = out (`El_start (tag n)); if d <> \"\" then out (`Data d); out `El_end in let o_bureaucrat b = out (`El_start (tag \"bureaucrat\")); o_el \"name\" b.name; o_el \"surname\" b.surname; if b.honest then o_el \"honest\" \"\"; o_el \"obfuscation_level\" (string_of_float b.obfuscation_level); List.iter (o_el \"tr\") b.trs; out `El_end in out (`Dtd None); out (`El_start (tag \"list\")); List.iter o_bureaucrat bl; out (`El_end)" }, - { "value": - { "name": "Cow.Xml.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|28319" }, - "info": "", - "type": "Cow.Xml.t -> string", - "params": [ - { "name": "", - "type": "Cow.Xml.t" } ] } }, - { "value": - { "name": "Cow.Xml.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|28347" }, - "info": "", - "type": "?entity:(string -> string option) ->\n ?templates:(string * Cow.Xml.t) list ->\n ?enc:Cow.Xml.encoding -> string -> Cow.Xml.t", - "params": [ - { "name": "entity", - "type": "(string -> string option) option" }, - { "name": "templates", - "type": "(string * Cow.Xml.t) list option" }, - { "name": "enc", - "type": "Cow.Xml.encoding option" }, - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Html", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30203" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Cow.Html.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30228" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "('a Cow.Xml.frag as 'a) Cow.Xml.frag list" } }, - { "value": - { "name": "Cow.Html.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30269" }, - "info": "", - "type": "Cow.Html.t -> string", - "params": [ - { "name": "", - "type": "Cow.Html.t" } ] } }, - { "value": - { "name": "Cow.Html.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30298" }, - "info": "", - "type": "?templates:(string * Cow.Html.t) list ->\n ?enc:Cow.Xml.encoding -> string -> Cow.Html.t", - "params": [ - { "name": "templates", - "type": "(string * Cow.Html.t) list option" }, - { "name": "enc", - "type": "Cow.Xml.encoding option" }, - { "name": "", - "type": "string" } ] } }, - { "comment": "

HTML library

" }, - { "type": - { "name": "Cow.Html.link", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30420" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "text", - "mutable": false, - "type": "string" }, - { "name": "href", - "mutable": false, - "type": "string" } ] } } }, - { "value": - { "name": "Cow.Html.html_of_link", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30465" }, - "info": "", - "type": "Cow.Html.link -> Cow.Html.t", - "params": [ - { "name": "", - "type": "Cow.Html.link" } ] } }, - { "value": - { "name": "Cow.Html.interleave", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30495" }, - "info": "", - "type": "string array -> Cow.Html.t list -> Cow.Html.t list", - "params": [ - { "name": "", - "type": "string array" }, - { "name": "", - "type": "Cow.Html.t list" } ] } }, - { "value": - { "name": "Cow.Html.html_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30546" }, - "info": "", - "type": "string -> Cow.Html.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Cow.Html.html_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30579" }, - "info": "", - "type": "int -> Cow.Html.t", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Cow.Html.html_of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30606" }, - "info": "", - "type": "float -> Cow.Html.t", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "type": - { "name": "Cow.Html.table", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30643" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Cow.Html.t array array" } }, - { "value": - { "name": "Cow.Html.html_of_table", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30666" }, - "info": "", - "type": "?headings:bool -> Cow.Html.table -> Cow.Html.t", - "params": [ - { "name": "headings", - "type": "bool option" }, - { "name": "", - "type": "Cow.Html.table" } ] } }, - { "value": - { "name": "Cow.Html.nil", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30716" }, - "info": "", - "type": "Cow.Html.t", - "params": [ ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Css", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30732" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Cow.Css.elt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30778" }, - "info": - { "description": "Single element" }, - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Str", - "type": [ "string" ] }, - { "name": "Fun", - "type": [ "string", "Cow.Css.expr list" ] } ] } } }, - { "type": - { "name": "Cow.Css.expr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30889" }, - "info": - { "description": "Expression: `.body a:hover`. No commas here." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Cow.Css.elt list" } }, - { "type": - { "name": "Cow.Css.prop_decl", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|30947" }, - "info": - { "description": "We allow nested declarations" }, - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Prop", - "type": [ "string", "Cow.Css.expr list" ] }, - { "name": "Decl", - "type": [ "Cow.Css.expr list", "Cow.Css.prop_decl list" ] } ] } } }, - { "type": - { "name": "Cow.Css.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31124" }, - "info": - { "description": "The type of CSS fragment" }, - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Props", - "type": [ "Cow.Css.prop_decl list" ] }, - { "name": "Exprs", - "type": [ "Cow.Css.expr list" ] } ] } } }, - { "value": - { "name": "Cow.Css.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31180" }, - "info": "", - "type": "Cow.Css.t -> string", - "params": [ - { "name": "", - "type": "Cow.Css.t" } ] } }, - { "comment": "

Getters

" }, - { "value": - { "name": "Cow.Css.expr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31229" }, - "info": "", - "type": "Cow.Css.t -> Cow.Css.expr", - "params": [ - { "name": "", - "type": "Cow.Css.t" } ] } }, - { "value": - { "name": "Cow.Css.exprs", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31250" }, - "info": "", - "type": "Cow.Css.t -> Cow.Css.expr list", - "params": [ - { "name": "", - "type": "Cow.Css.t" } ] } }, - { "value": - { "name": "Cow.Css.props", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31277" }, - "info": "", - "type": "Cow.Css.t -> Cow.Css.prop_decl list", - "params": [ - { "name": "", - "type": "Cow.Css.t" } ] } }, - { "value": - { "name": "Cow.Css.string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31309" }, - "info": "", - "type": "Cow.Css.t -> string", - "params": [ - { "name": "", - "type": "Cow.Css.t" } ] } }, - { "comment": "

Helpers

" }, - { "value": - { "name": "Cow.Css.unroll", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31468" }, - "info": - { "description": "transform a fragment with nested declarations into an equivalent fragment with only root declarations" }, - "type": "Cow.Css.t -> Cow.Css.t", - "params": [ - { "name": "", - "type": "Cow.Css.t" } ] } }, - { "comment": "

CSS library

" }, - { "value": - { "name": "Cow.Css.gradient", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31513" }, - "info": "", - "type": "low:Cow.Css.t -> high:Cow.Css.t -> Cow.Css.t", - "params": [ - { "name": "low", - "type": "Cow.Css.t" }, - { "name": "high", - "type": "Cow.Css.t" } ] } }, - { "value": - { "name": "Cow.Css.top_rounded", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31550" }, - "info": "", - "type": "Cow.Css.t", - "params": [ ] } }, - { "value": - { "name": "Cow.Css.bottom_rounded", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31570" }, - "info": "", - "type": "Cow.Css.t", - "params": [ ] } }, - { "value": - { "name": "Cow.Css.rounded", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31593" }, - "info": "", - "type": "Cow.Css.t", - "params": [ ] } }, - { "value": - { "name": "Cow.Css.box_shadow", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31610" }, - "info": "", - "type": "Cow.Css.t", - "params": [ ] } }, - { "value": - { "name": "Cow.Css.text_shadow", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31629" }, - "info": "", - "type": "Cow.Css.t", - "params": [ ] } }, - { "value": - { "name": "Cow.Css.no_padding", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31650" }, - "info": "", - "type": "Cow.Css.t", - "params": [ ] } }, - { "value": - { "name": "Cow.Css.reset_padding", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31669" }, - "info": "", - "type": "Cow.Css.t", - "params": [ ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Code", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31696" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Cow.Code.ocaml", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31825" }, - "info": - { "description": "Convert a string into an xHTML fragment, where keywords have been classified in different classes" }, - "type": "string -> Cow.Html.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Cow.Code.ocaml_css", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31926" }, - "info": - { "description": "CSS fragment to colorize the keywords, depending on their class" }, - "type": "Cow.Css.t", - "params": [ ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Atom", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31952" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Cow.Atom.author", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|31977" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "name", - "mutable": false, - "type": "string" }, - { "name": "uri", - "mutable": false, - "type": "string option" }, - { "name": "email", - "mutable": false, - "type": "string option" } ] } } }, - { "type": - { "name": "Cow.Atom.date", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32064" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int * int * int * int * int" } }, - { "value": - { "name": "Cow.Atom.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32100" }, - "info": "", - "type": "Cow.Atom.date -> Cow.Atom.date -> int", - "params": [ - { "name": "", - "type": "Cow.Atom.date" }, - { "name": "", - "type": "Cow.Atom.date" } ] } }, - { "type": - { "name": "Cow.Atom.meta", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32140" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "id", - "mutable": false, - "type": "string" }, - { "name": "title", - "mutable": false, - "type": "string" }, - { "name": "subtitle", - "mutable": false, - "type": "string option" }, - { "name": "author", - "mutable": false, - "type": "Cow.Atom.author option" }, - { "name": "rights", - "mutable": false, - "type": "string option" }, - { "name": "updated", - "mutable": false, - "type": "Cow.Atom.date" } ] } } }, - { "type": - { "name": "Cow.Atom.summary", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32326" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string option" } }, - { "type": - { "name": "Cow.Atom.entry", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32356" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "entry", - "mutable": false, - "type": "Cow.Atom.meta" }, - { "name": "summary", - "mutable": false, - "type": "Cow.Atom.summary" }, - { "name": "content", - "mutable": false, - "type": "Cow.Xml.t" } ] } } }, - { "type": - { "name": "Cow.Atom.feed", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32432" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "feed", - "mutable": false, - "type": "Cow.Atom.meta" }, - { "name": "entries", - "mutable": false, - "type": "Cow.Atom.entry list" } ] } } }, - { "value": - { "name": "Cow.Atom.xml_of_feed", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32486" }, - "info": "", - "type": "?self:string -> Cow.Atom.feed -> Cow.Xml.t", - "params": [ - { "name": "self", - "type": "string option" }, - { "name": "", - "type": "Cow.Atom.feed" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Markdown", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32539" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Cow.Markdown.ref", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32568" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "src", - "mutable": false, - "type": "string" }, - { "name": "desc", - "mutable": false, - "type": "string" } ] } } }, - { "type": - { "name": "Cow.Markdown.paragraph", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32612" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Normal", - "type": [ "Cow.Markdown.par_text" ] }, - { "name": "Html", - "type": [ "Cow.Html.t" ] }, - { "name": "Pre", - "type": [ "string", "string option" ] }, - { "name": "Heading", - "type": [ "int", "Cow.Markdown.par_text" ] }, - { "name": "Quote", - "type": [ "Cow.Markdown.paragraph list" ] }, - { "name": "Ulist", - "type": [ "Cow.Markdown.paragraph list", "Cow.Markdown.paragraph list list" ] }, - { "name": "Olist", - "type": [ "Cow.Markdown.paragraph list", "Cow.Markdown.paragraph list list" ] } ] } } }, - { "type": - { "name": "Cow.Markdown.par_text", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32863" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Cow.Markdown.text list" } }, - { "type": - { "name": "Cow.Markdown.text", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|32889" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Text", - "type": [ "string" ] }, - { "name": "Emph", - "type": [ "string" ] }, - { "name": "Bold", - "type": [ "string" ] }, - { "name": "Struck", - "type": [ "Cow.Markdown.par_text" ] }, - { "name": "Code", - "type": [ "string" ] }, - { "name": "Link", - "type": [ "Cow.Markdown.href" ] }, - { "name": "Anchor", - "type": [ "string" ] }, - { "name": "Image", - "type": [ "Cow.Markdown.img_ref" ] } ] } } }, - { "type": - { "name": "Cow.Markdown.href", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33059" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "href_target", - "mutable": false, - "type": "string" }, - { "name": "href_desc", - "mutable": false, - "type": "string" } ] } } }, - { "type": - { "name": "Cow.Markdown.img_ref", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33117" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "img_src", - "mutable": false, - "type": "string" }, - { "name": "img_alt", - "mutable": false, - "type": "string" } ] } } }, - { "type": - { "name": "Cow.Markdown.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33172" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Cow.Markdown.paragraph list" } }, - { "value": - { "name": "Cow.Markdown.to_html", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33193" }, - "info": "", - "type": "Cow.Markdown.t -> Cow.Html.t", - "params": [ - { "name": "", - "type": "Cow.Markdown.t" } ] } }, - { "value": - { "name": "Cow.Markdown.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33220" }, - "info": "", - "type": "string -> Cow.Markdown.t", - "params": [ - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Json", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33252" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Cow.Json.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33277" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Int", - "type": [ "int64" ] }, - { "name": "Bool", - "type": [ "bool" ] }, - { "name": "Float", - "type": [ "float" ] }, - { "name": "String", - "type": [ "string" ] }, - { "name": "Array", - "type": [ "Cow.Json.t list" ] }, - { "name": "Object", - "type": [ "(string * Cow.Json.t) list" ] }, - { "name": "Null", - "type": [ ] } ] } } }, - { "value": - { "name": "Cow.Json.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33417" }, - "info": "", - "type": "Cow.Json.t -> string", - "params": [ - { "name": "", - "type": "Cow.Json.t" } ] } }, - { "value": - { "name": "Cow.Json.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33445" }, - "info": "", - "type": "string -> Cow.Json.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "exception": - { "name": "Cow.Json.Runtime_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33474" }, - "info": "", - "exception_args": [ "string", "Cow.Json.t" ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Twitter", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33516" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Cow.Twitter.User", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33539" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Cow.Twitter.User.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33567" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "id_str", - "mutable": false, - "type": "string" }, - { "name": "screen_name", - "mutable": false, - "type": "string" } ] } } }, - { "value": - { "name": "Cow.Twitter.User.json_of_t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33631" }, - "info": "", - "type": "Cow.Twitter.User.t -> Cow.Json.t", - "params": [ - { "name": "", - "type": "Cow.Twitter.User.t" } ] } }, - { "value": - { "name": "Cow.Twitter.User.t_of_json", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33661" }, - "info": "", - "type": "Cow.Json.t -> Cow.Twitter.User.t", - "params": [ - { "name": "", - "type": "Cow.Json.t" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Cow.Twitter.Status", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33695" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Cow.Twitter.Status.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33723" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "id", - "mutable": false, - "type": "int" }, - { "name": "user", - "mutable": false, - "type": "Cow.Twitter.User.t" }, - { "name": "text", - "mutable": false, - "type": "string" } ] } } }, - { "value": - { "name": "Cow.Twitter.Status.json_of_t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33790" }, - "info": "", - "type": "Cow.Twitter.Status.t -> Cow.Json.t", - "params": [ - { "name": "", - "type": "Cow.Twitter.Status.t" } ] } }, - { "value": - { "name": "Cow.Twitter.Status.t_of_json", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33820" }, - "info": "", - "type": "Cow.Json.t -> Cow.Twitter.Status.t", - "params": [ - { "name": "", - "type": "Cow.Json.t" } ] } }, - { "value": - { "name": "Cow.Twitter.Status.json_of_t_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33851" }, - "info": "", - "type": "Cow.Twitter.Status.t list -> Cow.Json.t", - "params": [ - { "name": "", - "type": "Cow.Twitter.Status.t list" } ] } }, - { "value": - { "name": "Cow.Twitter.Status.t_list_of_json", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/cow.mli|33891" }, - "info": "", - "type": "Cow.Json.t -> Cow.Twitter.Status.t list", - "params": [ - { "name": "", - "type": "Cow.Json.t" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ "Buffer", "*predef*" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Digest.json b/data/Digest.json deleted file mode 100644 index 3c6319a..0000000 --- a/data/Digest.json +++ /dev/null @@ -1,72 +0,0 @@ -{ "module": - { "name": "Digest", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/digest.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/digest.mli|0" }, - "info": - { "description": "MD5 message digest.

This module provides functions to compute 128-bit ``digests'' of arbitrary-length strings or files. The digests are of cryptographic quality: it is very hard, given a digest, to forge a string having that digest. The algorithm used is MD5." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Digest.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/digest.mli|1234" }, - "info": - { "description": "The type of digests: 16-character strings." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string" } }, - { "value": - { "name": "Digest.string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/digest.mli|1296" }, - "info": - { "description": "Return the digest of the given string." }, - "type": "string -> Digest.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Digest.substring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/digest.mli|1368" }, - "info": - { "description": "Digest.substring s ofs len returns the digest of the substring of s starting at character number ofs and containing len characters." }, - "type": "string -> int -> int -> Digest.t", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Digest.file", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/digest.mli|1564" }, - "info": - { "description": "Return the digest of the file whose name is given." }, - "type": "string -> Digest.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Digest.to_hex", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/digest.mli|1646" }, - "info": - { "description": "Return the printable hexadecimal representation of the given digest." }, - "type": "Digest.t -> string", - "params": [ - { "name": "", - "type": "Digest.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Dns.json b/data/Dns.json deleted file mode 100644 index d8b0846..0000000 --- a/data/Dns.json +++ /dev/null @@ -1,2065 +0,0 @@ -{ "module": - { "name": "Dns", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|0" }, - "info": - { "description": "create n creates an empty table of initial size n. The table will grow as needed." }, - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Dns.Hashcons", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Dns.Hashcons.hash_consed", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|592" }, - "info": "", - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" } ], - "kind": - { "type": "record", - "private": "true", - "fields": [ - { "name": "hkey", - "mutable": false, - "type": "int" }, - { "name": "tag", - "mutable": false, - "type": "int" }, - { "name": "node", - "mutable": false, - "type": "'a" } ] } } }, - { "type": - { "name": "Dns.Hashcons.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|737" }, - "info": "", - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Dns.Hashcons.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|744" }, - "info": - { "description": "create n creates an empty table of initial size n. The table will grow as needed." }, - "type": "int -> 'a Dns.Hashcons.t", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Hashcons.clear", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|872" }, - "info": - { "description": "Removes all elements from the table." }, - "type": "'a Dns.Hashcons.t -> unit", - "params": [ - { "name": "", - "type": "'a Dns.Hashcons.t" } ] } }, - { "value": - { "name": "Dns.Hashcons.hashcons", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|943" }, - "info": - { "description": "hashcons t n hash-cons the value n using table t i.e. returns any existing value in t equal to n, if any; otherwise, allocates a new one hash-consed value of node n and returns it. As a consequence the returned value is physically equal to any equal value already hash-consed using table t." }, - "type": "'a Dns.Hashcons.t -> 'a -> 'a Dns.Hashcons.hash_consed", - "params": [ - { "name": "", - "type": "'a Dns.Hashcons.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Dns.Hashcons.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|1326" }, - "info": - { "description": "iter f t iterates f over all elements of t." }, - "type": "('a Dns.Hashcons.hash_consed -> unit) -> 'a Dns.Hashcons.t -> unit", - "params": [ - { "name": "", - "type": "'a Dns.Hashcons.hash_consed -> unit" }, - { "name": "", - "type": "'a Dns.Hashcons.t" } ] } }, - { "value": - { "name": "Dns.Hashcons.stats", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|1437" }, - "info": - { "description": "Return statistics on the table. The numbers are, in order: table length, number of entries, sum of bucket lengths, smallest bucket length, median bucket length, biggest bucket length." }, - "type": "'a Dns.Hashcons.t -> int * int * int * int * int * int", - "params": [ - { "name": "", - "type": "'a Dns.Hashcons.t" } ] } }, - { "module_type": - { "name": "Dns.Hashcons.HashedType", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|1729" }, - "info": "", - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Dns.Hashcons.S", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|1833" }, - "info": "", - "type": "sig end", - "kind": "" } }, - { "module": - { "name": "Dns.Hashcons.Make", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2094" }, - "info": "", - "type": "functor (H : HashedType) -> sig end", - "module_functor": - { "parameter": - { "name": "H" }, - "module_with": "unavailable" }, - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Dnsrr", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2152" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Dns.Dnsrr.serial", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2178" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int32" } }, - { "type": - { "name": "Dns.Dnsrr.ipv4", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2198" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int32" } }, - { "type": - { "name": "Dns.Dnsrr.cstr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2215" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string Dns.Hashcons.hash_consed" } }, - { "type": - { "name": "Dns.Dnsrr.dnsnode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2254" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "owner", - "mutable": false, - "type": "string list Dns.Hashcons.hash_consed" }, - { "name": "rrsets", - "mutable": true, - "type": "Dns.Dnsrr.rrset list" } ] } } }, - { "type": - { "name": "Dns.Dnsrr.rrset", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2346" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "ttl", - "mutable": false, - "type": "int32" }, - { "name": "rdata", - "mutable": false, - "type": "Dns.Dnsrr.rdata" } ] } } }, - { "type": - { "name": "Dns.Dnsrr.rdata", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|2390" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "A", - "type": [ "Dns.Dnsrr.ipv4 list" ] }, - { "name": "NS", - "type": [ "Dns.Dnsrr.dnsnode list" ] }, - { "name": "CNAME", - "type": [ "Dns.Dnsrr.dnsnode list" ] }, - { "name": "SOA", - "type": [ "(Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode * Dns.Dnsrr.serial * int32 * int32 *\n int32 * int32)\n list" ] }, - { "name": "MB", - "type": [ "Dns.Dnsrr.dnsnode list" ] }, - { "name": "MG", - "type": [ "Dns.Dnsrr.dnsnode list" ] }, - { "name": "MR", - "type": [ "Dns.Dnsrr.dnsnode list" ] }, - { "name": "WKS", - "type": [ "(int32 * int * Dns.Dnsrr.cstr) list" ] }, - { "name": "PTR", - "type": [ "Dns.Dnsrr.dnsnode list" ] }, - { "name": "HINFO", - "type": [ "(Dns.Dnsrr.cstr * Dns.Dnsrr.cstr) list" ] }, - { "name": "MINFO", - "type": [ "(Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode) list" ] }, - { "name": "MX", - "type": [ "(int * Dns.Dnsrr.dnsnode) list" ] }, - { "name": "TXT", - "type": [ "Dns.Dnsrr.cstr list list" ] }, - { "name": "RP", - "type": [ "(Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode) list" ] }, - { "name": "AFSDB", - "type": [ "(int * Dns.Dnsrr.dnsnode) list" ] }, - { "name": "X25", - "type": [ "Dns.Dnsrr.cstr list" ] }, - { "name": "ISDN", - "type": [ "(Dns.Dnsrr.cstr * Dns.Dnsrr.cstr option) list" ] }, - { "name": "RT", - "type": [ "(int * Dns.Dnsrr.dnsnode) list" ] }, - { "name": "AAAA", - "type": [ "Dns.Dnsrr.cstr list" ] }, - { "name": "SRV", - "type": [ "(int * int * int * Dns.Dnsrr.dnsnode) list" ] }, - { "name": "UNSPEC", - "type": [ "Dns.Dnsrr.cstr list" ] }, - { "name": "Unknown", - "type": [ "int", "Dns.Dnsrr.cstr list" ] } ] } } }, - { "value": - { "name": "Dns.Dnsrr.hashcons_charstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3103" }, - "info": "", - "type": "string -> Dns.Dnsrr.cstr", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Dns.Dnsrr.hashcons_domainname", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3144" }, - "info": "", - "type": "string list -> string list Dns.Hashcons.hash_consed", - "params": [ - { "name": "", - "type": "string list" } ] } }, - { "value": - { "name": "Dns.Dnsrr.clear_cons_tables", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3218" }, - "info": "", - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Dns.Dnsrr.get_rrsets", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3373" }, - "info": "", - "type": "[> `A\n | `AAAA\n | `AFSDB\n | `ANY\n | `CNAME\n | `HINFO\n | `ISDN\n | `MAILB\n | `MB\n | `MG\n | `MINFO\n | `MR\n | `MX\n | `NS\n | `PTR\n | `RP\n | `RT\n | `SOA\n | `SRV\n | `TXT\n | `UNSPEC\n | `Unknown of int * string\n | `WKS\n | `X25 ] ->\n Dns.Dnsrr.rrset list -> bool -> Dns.Dnsrr.rrset list", - "params": [ - { "name": "", - "type": "[> `A\n | `AAAA\n | `AFSDB\n | `ANY\n | `CNAME\n | `HINFO\n | `ISDN\n | `MAILB\n | `MB\n | `MG\n | `MINFO\n | `MR\n | `MX\n | `NS\n | `PTR\n | `RP\n | `RT\n | `SOA\n | `SRV\n | `TXT\n | `UNSPEC\n | `Unknown of int * string\n | `WKS\n | `X25 ]" }, - { "name": "", - "type": "Dns.Dnsrr.rrset list" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Dns.Dnsrr.merge_rrset", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3799" }, - "info": "", - "type": "Dns.Dnsrr.rrset -> Dns.Dnsrr.rrset list -> int32 * Dns.Dnsrr.rrset list", - "params": [ - { "name": "", - "type": "Dns.Dnsrr.rrset" }, - { "name": "", - "type": "Dns.Dnsrr.rrset list" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Dnstrie", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3863" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Dns.Dnstrie.dnstrie", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3891" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "Dns.Dnstrie.key", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3931" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "exception": - { "name": "Dns.Dnstrie.BadDomainName", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|3970" }, - "info": "", - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Dns.Dnstrie.TrieCorrupt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|4039" }, - "info": "" } }, - { "value": - { "name": "Dns.Dnstrie.canon2key", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|4237" }, - "info": "", - "type": "string list -> Dns.Dnstrie.key", - "params": [ - { "name": "", - "type": "string list" } ] } }, - { "value": - { "name": "Dns.Dnstrie.new_trie", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|4304" }, - "info": "", - "type": "unit -> Dns.Dnstrie.dnstrie", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Dns.Dnstrie.simple_lookup", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|4385" }, - "info": "", - "type": "Dns.Dnstrie.key -> Dns.Dnstrie.dnstrie -> Dns.Dnsrr.dnsnode option", - "params": [ - { "name": "", - "type": "Dns.Dnstrie.key" }, - { "name": "", - "type": "Dns.Dnstrie.dnstrie" } ] } }, - { "value": - { "name": "Dns.Dnstrie.lookup", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|4501" }, - "info": "", - "type": "Dns.Dnstrie.key ->\n Dns.Dnstrie.dnstrie ->\n [> `Delegated of bool * Dns.Dnsrr.dnsnode\n | `Found of bool * Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode\n | `NXDomain of Dns.Dnsrr.dnsnode\n | `NXDomainNSEC of Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode\n | `NoError of Dns.Dnsrr.dnsnode\n | `NoErrorNSEC of Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode\n | `Wildcard of Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode\n | `WildcardNSEC of Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode * Dns.Dnsrr.dnsnode ]", - "params": [ - { "name": "", - "type": "Dns.Dnstrie.key" }, - { "name": "", - "type": "Dns.Dnstrie.dnstrie" } ] } }, - { "value": - { "name": "Dns.Dnstrie.lookup_or_insert", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5032" }, - "info": "", - "type": "Dns.Dnstrie.key ->\n Dns.Dnstrie.dnstrie ->\n ?parent:Dns.Dnstrie.dnstrie ->\n (unit -> Dns.Dnsrr.dnsnode) -> Dns.Dnsrr.dnsnode", - "params": [ - { "name": "", - "type": "Dns.Dnstrie.key" }, - { "name": "", - "type": "Dns.Dnstrie.dnstrie" }, - { "name": "parent", - "type": "Dns.Dnstrie.dnstrie option" }, - { "name": "", - "type": "unit -> Dns.Dnsrr.dnsnode" } ] } }, - { "value": - { "name": "Dns.Dnstrie.fix_flags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5235" }, - "info": "", - "type": "Dns.Dnstrie.key -> Dns.Dnstrie.dnstrie -> unit", - "params": [ - { "name": "", - "type": "Dns.Dnstrie.key" }, - { "name": "", - "type": "Dns.Dnstrie.dnstrie" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Dnsloader", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5279" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Dns.Dnsloader.db", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5385" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "trie", - "mutable": false, - "type": "Dns.Dnstrie.dnstrie" }, - { "name": "names", - "mutable": true, - "type": "(Dns.Dnstrie.key, Dns.Dnsrr.dnsnode) Hashtbl.t" } ] } } }, - { "value": - { "name": "Dns.Dnsloader.new_db", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5515" }, - "info": "", - "type": "unit -> Dns.Dnsloader.db", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Dns.Dnsloader.no_more_updates", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5597" }, - "info": "", - "type": "Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_generic_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5696" }, - "info": "", - "type": "int -> string -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_a_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5769" }, - "info": "", - "type": "Dns.Dnsrr.ipv4 -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "Dns.Dnsrr.ipv4" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_ns_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5833" }, - "info": "", - "type": "string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_cname_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5899" }, - "info": "", - "type": "string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_soa_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|5968" }, - "info": "", - "type": "string list ->\n string list ->\n Dns.Dnsrr.serial ->\n int32 ->\n int32 -> int32 -> int32 -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsrr.serial" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_mb_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6116" }, - "info": "", - "type": "string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_mg_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6182" }, - "info": "", - "type": "string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_mr_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6248" }, - "info": "", - "type": "string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_wks_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6314" }, - "info": "", - "type": "int32 -> int -> string -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_ptr_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6392" }, - "info": "", - "type": "string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_hinfo_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6459" }, - "info": "", - "type": "string -> string -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_minfo_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6533" }, - "info": "", - "type": "string list ->\n string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_mx_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6622" }, - "info": "", - "type": "int -> string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_txt_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6695" }, - "info": "", - "type": "string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_rp_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6762" }, - "info": "", - "type": "string list ->\n string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_afsdb_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6847" }, - "info": "", - "type": "int -> string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_x25_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6923" }, - "info": "", - "type": "string -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_isdn_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|6985" }, - "info": "", - "type": "string -> string option -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "string option" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_rt_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7065" }, - "info": "", - "type": "int -> string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_aaaa_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7138" }, - "info": "", - "type": "string -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_srv_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7201" }, - "info": "", - "type": "int ->\n int -> int -> string list -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "value": - { "name": "Dns.Dnsloader.add_unspec_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7291" }, - "info": "", - "type": "string -> int32 -> string list -> Dns.Dnsloader.db -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnsloader.db" } ] } }, - { "exception": - { "name": "Dns.Dnsloader.TTLMismatch", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7594" }, - "info": "" } }, - { "type": - { "name": "Dns.Dnsloader.parserstate", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7670" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "db", - "mutable": true, - "type": "Dns.Dnsloader.db" }, - { "name": "paren", - "mutable": true, - "type": "int" }, - { "name": "filename", - "mutable": true, - "type": "string" }, - { "name": "lineno", - "mutable": true, - "type": "int" }, - { "name": "origin", - "mutable": true, - "type": "string list" }, - { "name": "ttl", - "mutable": true, - "type": "int32" }, - { "name": "owner", - "mutable": true, - "type": "string list" } ] } } }, - { "value": - { "name": "Dns.Dnsloader.state", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7878" }, - "info": "", - "type": "Dns.Dnsloader.parserstate", - "params": [ ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Dnspacket", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7906" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "exception": - { "name": "Dns.Dnspacket.Unparsable", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7931" }, - "info": "", - "exception_args": [ "string", "Bitstring.bitstring" ] } }, - { "value": - { "name": "Dns.Dnspacket.(|>)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|7985" }, - "info": "", - "type": "'a -> ('a -> 'b) -> 'b", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a -> 'b" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(>>)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8021" }, - "info": "", - "type": "('a -> 'b) -> ('b -> 'c) -> 'a -> 'c", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(||>)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8071" }, - "info": "", - "type": "'a list -> ('a -> 'b) -> 'b list", - "params": [ - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a -> 'b" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(+++)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8118" }, - "info": "", - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(&&&)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8156" }, - "info": "", - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(|||)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8194" }, - "info": "", - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(^^^)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8232" }, - "info": "", - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(<<<)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8270" }, - "info": "", - "type": "int32 -> int -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.(>>>)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8306" }, - "info": "", - "type": "int32 -> int -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.join", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8342" }, - "info": "", - "type": "string -> string list -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "string list" } ] } }, - { "value": - { "name": "Dns.Dnspacket.stop", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8385" }, - "info": "", - "type": "'a * 'b -> 'a", - "params": [ - { "tuple": - { "type": "'a * 'b", - "contents": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } } ] } }, - { "type": - { "name": "Dns.Dnspacket.domain_name", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8415" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string list" } }, - { "type": - { "name": "Dns.Dnspacket.int16", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8446" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int" } }, - { "type": - { "name": "Dns.Dnspacket.ipv4", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8463" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int32" } }, - { "value": - { "name": "Dns.Dnspacket.ipv4_to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8476" }, - "info": "", - "type": "int32 -> string", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "type": - { "name": "Dns.Dnspacket.byte", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8518" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "char" } }, - { "value": - { "name": "Dns.Dnspacket.byte", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8530" }, - "info": "", - "type": "int -> Dns.Dnspacket.byte", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.int_of_byte", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8553" }, - "info": "", - "type": "char -> int", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Dns.Dnspacket.int32_of_byte", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8583" }, - "info": "", - "type": "char -> int32", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Dns.Dnspacket.int32_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8617" }, - "info": "", - "type": "int -> int32", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "type": - { "name": "Dns.Dnspacket.bytes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8654" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string" } }, - { "value": - { "name": "Dns.Dnspacket.bytes_to_hex_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8669" }, - "info": "", - "type": "char array -> string array", - "params": [ - { "name": "", - "type": "char array" } ] } }, - { "value": - { "name": "Dns.Dnspacket.bytes_of_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8722" }, - "info": "", - "type": "Bitstring.bitstring -> string", - "params": [ - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Dns.Dnspacket.ipv4_addr_of_bytes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8777" }, - "info": "", - "type": "string -> int32", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "type": - { "name": "Dns.Dnspacket.label", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8823" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "L", - "type": [ "string", "int" ] }, - { "name": "P", - "type": [ "int", "int" ] }, - { "name": "Z", - "type": [ "int" ] } ] } } }, - { "value": - { "name": "Dns.Dnspacket.parse_charstr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8877" }, - "info": "", - "type": "string * int * int -> string * (string * int * int)", - "params": [ - { "tuple": - { "type": "string * int * int", - "contents": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } } ] } }, - { "value": - { "name": "Dns.Dnspacket.parse_label", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|8949" }, - "info": "", - "type": "int -> Bitstring.bitstring -> Dns.Dnspacket.label * (string * int * int)", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Dns.Dnspacket.parse_name", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|9026" }, - "info": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t ->\n int -> Bitstring.bitstring -> string list * Bitstring.bitstring", - "params": [ - { "name": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "type": - { "name": "Dns.Dnspacket.rr_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|9138" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `A\n | `A6\n | `AAAA\n | `AFSDB\n | `APL\n | `ATMA\n | `CERT\n | `CNAME\n | `DNAME\n | `DNSKEY\n | `DS\n | `EID\n | `GID\n | `GPOS\n | `HINFO\n | `IPSECKEY\n | `ISDN\n | `KEY\n | `KM\n | `LOC\n | `MB\n | `MD\n | `MF\n | `MG\n | `MINFO\n | `MR\n | `MX\n | `NAPTR\n | `NIMLOC\n | `NS\n | `NSAP\n | `NSAP_PTR\n | `NSEC\n | `NULL\n | `NXT\n | `OPT\n | `PTR\n | `PX\n | `RP\n | `RRSIG\n | `RT\n | `SIG\n | `SINK\n | `SOA\n | `SPF\n | `SRV\n | `SSHFP\n | `TXT\n | `UID\n | `UINFO\n | `UNSPEC\n | `Unknown of int * Dns.Dnspacket.bytes\n | `WKS\n | `X25 ]" } }, - { "value": - { "name": "Dns.Dnspacket.int_of_rr_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|9794" }, - "info": "", - "type": "Dns.Dnspacket.rr_type -> int", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.rr_type" } ] } }, - { "value": - { "name": "Dns.Dnspacket.rr_type_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|9830" }, - "info": "", - "type": "int -> Dns.Dnspacket.rr_type", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.string_of_rr_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|9866" }, - "info": "", - "type": "Dns.Dnspacket.rr_type -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.rr_type" } ] } }, - { "type": - { "name": "Dns.Dnspacket.rr_rdata", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|9913" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `A of int32\n | `AAAA of Dns.Dnspacket.bytes\n | `AFSDB of Dns.Dnspacket.int16 * Dns.Dnspacket.domain_name\n | `CNAME of Dns.Dnspacket.domain_name\n | `HINFO of string * string\n | `ISDN of string\n | `MB of Dns.Dnspacket.domain_name\n | `MD of Dns.Dnspacket.domain_name\n | `MF of Dns.Dnspacket.domain_name\n | `MG of Dns.Dnspacket.domain_name\n | `MINFO of Dns.Dnspacket.domain_name * Dns.Dnspacket.domain_name\n | `MR of Dns.Dnspacket.domain_name\n | `MX of Dns.Dnspacket.int16 * Dns.Dnspacket.domain_name\n | `NS of Dns.Dnspacket.domain_name\n | `PTR of Dns.Dnspacket.domain_name\n | `RP of Dns.Dnspacket.domain_name * Dns.Dnspacket.domain_name\n | `RT of Dns.Dnspacket.int16 * Dns.Dnspacket.domain_name\n | `SOA of\n Dns.Dnspacket.domain_name * Dns.Dnspacket.domain_name * int32 * int32 *\n int32 * int32 * int32\n | `SRV of\n Dns.Dnspacket.int16 * Dns.Dnspacket.int16 * Dns.Dnspacket.int16 *\n Dns.Dnspacket.domain_name\n | `TXT of string list\n | `UNKNOWN of int * Dns.Dnspacket.bytes\n | `UNSPEC of Dns.Dnspacket.bytes\n | `WKS of int32 * Dns.Dnspacket.byte * string\n | `X25 of string ]" } }, - { "value": - { "name": "Dns.Dnspacket.string_of_rdata", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|10680" }, - "info": "", - "type": "[> `A of int32 | `NS of string list ] -> string", - "params": [ - { "name": "", - "type": "[> `A of int32 | `NS of string list ]" } ] } }, - { "value": - { "name": "Dns.Dnspacket.parse_rdata", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|10750" }, - "info": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t ->\n int ->\n Dns.Dnspacket.rr_type ->\n Bitstring.bitstring ->\n [> `A of int32\n | `CNAME of string list\n | `HINFO of string * string\n | `MINFO of string list * string list\n | `MX of int * string list\n | `NS of string list\n | `PTR of string list\n | `SOA of string list * string list * int32 * int32 * int32 * int32 * int32\n | `TXT of 'a\n | `UNKNOWN of int * string\n | `WKS of int32 * Dns.Dnspacket.byte * string ]", - "params": [ - { "name": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "Dns.Dnspacket.rr_type" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "type": - { "name": "Dns.Dnspacket.rr_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11197" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `CH | `CS | `HS | `IN ]" } }, - { "value": - { "name": "Dns.Dnspacket.int_of_rr_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11234" }, - "info": "", - "type": "Dns.Dnspacket.rr_class -> int", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.rr_class" } ] } }, - { "value": - { "name": "Dns.Dnspacket.rr_class_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11272" }, - "info": "", - "type": "int -> Dns.Dnspacket.rr_class", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.string_of_rr_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11310" }, - "info": "", - "type": "Dns.Dnspacket.rr_class -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.rr_class" } ] } }, - { "type": - { "name": "Dns.Dnspacket.rsrc_record", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11359" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "rr_name", - "mutable": false, - "type": "Dns.Dnspacket.domain_name" }, - { "name": "rr_class", - "mutable": false, - "type": "Dns.Dnspacket.rr_class" }, - { "name": "rr_ttl", - "mutable": false, - "type": "int32" }, - { "name": "rr_rdata", - "mutable": false, - "type": "Dns.Dnspacket.rr_rdata" } ] } } }, - { "value": - { "name": "Dns.Dnspacket.rr_to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11466" }, - "info": "", - "type": "Dns.Dnspacket.rsrc_record -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.rsrc_record" } ] } }, - { "value": - { "name": "Dns.Dnspacket.parse_rr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11507" }, - "info": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t ->\n int ->\n Bitstring.bitstring -> Dns.Dnspacket.rsrc_record * (string * int * int)", - "params": [ - { "name": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "type": - { "name": "Dns.Dnspacket.q_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|11618" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `A\n | `A6\n | `AAAA\n | `AFSDB\n | `ANY\n | `APL\n | `ATMA\n | `AXFR\n | `CERT\n | `CNAME\n | `DLV\n | `DNAME\n | `DNSKEY\n | `DS\n | `EID\n | `GID\n | `GPOS\n | `HINFO\n | `IPSECKEY\n | `ISDN\n | `KEY\n | `KM\n | `LOC\n | `MAILA\n | `MAILB\n | `MB\n | `MD\n | `MF\n | `MG\n | `MINFO\n | `MR\n | `MX\n | `NAPTR\n | `NIMLOC\n | `NS\n | `NSAP\n | `NSAP_PTR\n | `NSEC\n | `NULL\n | `NXT\n | `OPT\n | `PTR\n | `PX\n | `RP\n | `RRSIG\n | `RT\n | `SIG\n | `SINK\n | `SOA\n | `SPF\n | `SRV\n | `SSHFP\n | `TA\n | `TXT\n | `UID\n | `UINFO\n | `UNSPEC\n | `Unknown of int * Dns.Dnspacket.bytes\n | `WKS\n | `X25 ]" } }, - { "value": - { "name": "Dns.Dnspacket.int_of_q_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12343" }, - "info": "", - "type": "Dns.Dnspacket.q_type -> int", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.q_type" } ] } }, - { "value": - { "name": "Dns.Dnspacket.q_type_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12377" }, - "info": "", - "type": "int -> Dns.Dnspacket.q_type", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.string_of_q_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12411" }, - "info": "", - "type": "Dns.Dnspacket.q_type -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.q_type" } ] } }, - { "type": - { "name": "Dns.Dnspacket.q_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12456" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `ANY | `CH | `CS | `HS | `IN | `NONE ]" } }, - { "value": - { "name": "Dns.Dnspacket.int_of_q_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12507" }, - "info": "", - "type": "Dns.Dnspacket.q_class -> int", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.q_class" } ] } }, - { "value": - { "name": "Dns.Dnspacket.q_class_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12543" }, - "info": "", - "type": "int -> Dns.Dnspacket.q_class", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.string_of_q_class", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12579" }, - "info": "", - "type": "Dns.Dnspacket.q_class -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.q_class" } ] } }, - { "type": - { "name": "Dns.Dnspacket.question", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12626" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "q_name", - "mutable": false, - "type": "Dns.Dnspacket.domain_name" }, - { "name": "q_type", - "mutable": false, - "type": "Dns.Dnspacket.q_type" }, - { "name": "q_class", - "mutable": false, - "type": "Dns.Dnspacket.q_class" } ] } } }, - { "value": - { "name": "Dns.Dnspacket.question_to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12699" }, - "info": "", - "type": "Dns.Dnspacket.question -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.question" } ] } }, - { "value": - { "name": "Dns.Dnspacket.parse_question", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12743" }, - "info": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t ->\n int -> Bitstring.bitstring -> Dns.Dnspacket.question * (string * int * int)", - "params": [ - { "name": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "type": - { "name": "Dns.Dnspacket.qr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12857" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Answer | `Query ]" } }, - { "value": - { "name": "Dns.Dnspacket.qr_of_bool", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12883" }, - "info": "", - "type": "bool -> [> `Answer | `Query ]", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Dns.Dnspacket.bool_of_qr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12930" }, - "info": "", - "type": "[< `Answer | `Query ] -> bool", - "params": [ - { "name": "", - "type": "[< `Answer | `Query ]" } ] } }, - { "type": - { "name": "Dns.Dnspacket.opcode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|12982" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Answer | `Notify | `Query | `Reserved | `Status | `Update ]" } }, - { "value": - { "name": "Dns.Dnspacket.opcode_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|13054" }, - "info": "", - "type": "int -> [> `Answer | `Notify | `Query | `Reserved | `Status | `Update ]", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.int_of_opcode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|13145" }, - "info": "", - "type": "[> `Answer | `Notify | `Query | `Reserved | `Status | `Update ] -> int", - "params": [ - { "name": "", - "type": "[> `Answer | `Notify | `Query | `Reserved | `Status | `Update ]" } ] } }, - { "type": - { "name": "Dns.Dnspacket.rcode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|13241" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `BadAlg\n | `BadKey\n | `BadMode\n | `BadName\n | `BadTime\n | `BadVers\n | `FormErr\n | `NXDomain\n | `NXRRSet\n | `NoError\n | `NotAuth\n | `NotImp\n | `NotZone\n | `Refused\n | `ServFail\n | `YXDomain\n | `YXRRSet ]" } }, - { "value": - { "name": "Dns.Dnspacket.rcode_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|13506" }, - "info": "", - "type": "int ->\n [> `BadAlg\n | `BadKey\n | `BadMode\n | `BadName\n | `BadTime\n | `BadVers\n | `FormErr\n | `NXDomain\n | `NXRRSet\n | `NoError\n | `NotAuth\n | `NotImp\n | `NotZone\n | `Refused\n | `ServFail\n | `YXDomain\n | `YXRRSet ]", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Dns.Dnspacket.int_of_rcode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|13774" }, - "info": "", - "type": "[> `BadAlg\n | `BadKey\n | `BadMode\n | `BadName\n | `BadTime\n | `BadVers\n | `FormErr\n | `NXDomain\n | `NXRRSet\n | `NoError\n | `NotAuth\n | `NotImp\n | `NotZone\n | `Refused\n | `ServFail\n | `YXDomain\n | `YXRRSet ] ->\n int", - "params": [ - { "name": "", - "type": "[> `BadAlg\n | `BadKey\n | `BadMode\n | `BadName\n | `BadTime\n | `BadVers\n | `FormErr\n | `NXDomain\n | `NXRRSet\n | `NoError\n | `NotAuth\n | `NotImp\n | `NotZone\n | `Refused\n | `ServFail\n | `YXDomain\n | `YXRRSet ]" } ] } }, - { "type": - { "name": "Dns.Dnspacket.detail", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14047" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "qr", - "mutable": false, - "type": "Dns.Dnspacket.qr" }, - { "name": "opcode", - "mutable": false, - "type": "Dns.Dnspacket.opcode" }, - { "name": "aa", - "mutable": false, - "type": "bool" }, - { "name": "tc", - "mutable": false, - "type": "bool" }, - { "name": "rd", - "mutable": false, - "type": "bool" }, - { "name": "ra", - "mutable": false, - "type": "bool" }, - { "name": "rcode", - "mutable": false, - "type": "Dns.Dnspacket.rcode" } ] } } }, - { "value": - { "name": "Dns.Dnspacket.detail_to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14159" }, - "info": "", - "type": "Dns.Dnspacket.detail -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.detail" } ] } }, - { "value": - { "name": "Dns.Dnspacket.parse_detail", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14199" }, - "info": "", - "type": "string * int * int -> Dns.Dnspacket.detail", - "params": [ - { "tuple": - { "type": "string * int * int", - "contents": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } } ] } }, - { "value": - { "name": "Dns.Dnspacket.build_detail", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14247" }, - "info": "", - "type": "Dns.Dnspacket.detail -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.detail" } ] } }, - { "type": - { "name": "Dns.Dnspacket.dns", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14301" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "id", - "mutable": false, - "type": "Dns.Dnspacket.int16" }, - { "name": "detail", - "mutable": false, - "type": "Bitstring.t" }, - { "name": "questions", - "mutable": false, - "type": "Dns.Dnspacket.question list" }, - { "name": "answers", - "mutable": false, - "type": "Dns.Dnspacket.rsrc_record list" }, - { "name": "authorities", - "mutable": false, - "type": "Dns.Dnspacket.rsrc_record list" }, - { "name": "additionals", - "mutable": false, - "type": "Dns.Dnspacket.rsrc_record list" } ] } } }, - { "value": - { "name": "Dns.Dnspacket.dns_to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14476" }, - "info": "", - "type": "Dns.Dnspacket.dns -> string", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.dns" } ] } }, - { "value": - { "name": "Dns.Dnspacket.parse_dns", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14510" }, - "info": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t ->\n Bitstring.bitstring -> Dns.Dnspacket.dns", - "params": [ - { "name": "", - "type": "(int, Dns.Dnspacket.label) Hashtbl.t" }, - { "name": "", - "type": "Bitstring.bitstring" } ] } }, - { "value": - { "name": "Dns.Dnspacket.marshal", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14579" }, - "info": "", - "type": "Dns.Dnspacket.dns -> Bitstring.bitstring", - "params": [ - { "name": "", - "type": "Dns.Dnspacket.dns" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Dnsquery", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14624" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Dns.Dnsquery.query_answer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14653" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "rcode", - "mutable": false, - "type": "Dns.Dnspacket.rcode" }, - { "name": "aa", - "mutable": false, - "type": "bool" }, - { "name": "answer", - "mutable": false, - "type": "Dns.Dnspacket.rsrc_record list" }, - { "name": "authority", - "mutable": false, - "type": "Dns.Dnspacket.rsrc_record list" }, - { "name": "additional", - "mutable": false, - "type": "Dns.Dnspacket.rsrc_record list" } ] } } }, - { "value": - { "name": "Dns.Dnsquery.answer_query", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14833" }, - "info": "", - "type": "string list ->\n Dns.Dnspacket.q_type -> Dns.Dnstrie.dnstrie -> Dns.Dnsquery.query_answer", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "Dns.Dnspacket.q_type" }, - { "name": "", - "type": "Dns.Dnstrie.dnstrie" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Dnsparser", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14926" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Dns.Dnsparser.token", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|14954" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "EOF", - "type": [ ] }, - { "name": "EOL", - "type": [ ] }, - { "name": "SORIGIN", - "type": [ ] }, - { "name": "STTL", - "type": [ ] }, - { "name": "AT", - "type": [ ] }, - { "name": "DOT", - "type": [ ] }, - { "name": "SPACE", - "type": [ ] }, - { "name": "GENERIC", - "type": [ ] }, - { "name": "NUMBER", - "type": [ "string" ] }, - { "name": "CHARSTRING", - "type": [ "string" ] }, - { "name": "TYPE_A", - "type": [ "string" ] }, - { "name": "TYPE_NS", - "type": [ "string" ] }, - { "name": "TYPE_MD", - "type": [ "string" ] }, - { "name": "TYPE_MF", - "type": [ "string" ] }, - { "name": "TYPE_CNAME", - "type": [ "string" ] }, - { "name": "TYPE_SOA", - "type": [ "string" ] }, - { "name": "TYPE_MB", - "type": [ "string" ] }, - { "name": "TYPE_MG", - "type": [ "string" ] }, - { "name": "TYPE_MR", - "type": [ "string" ] }, - { "name": "TYPE_NULL", - "type": [ "string" ] }, - { "name": "TYPE_WKS", - "type": [ "string" ] }, - { "name": "TYPE_PTR", - "type": [ "string" ] }, - { "name": "TYPE_HINFO", - "type": [ "string" ] }, - { "name": "TYPE_MINFO", - "type": [ "string" ] }, - { "name": "TYPE_MX", - "type": [ "string" ] }, - { "name": "TYPE_TXT", - "type": [ "string" ] }, - { "name": "TYPE_RP", - "type": [ "string" ] }, - { "name": "TYPE_AFSDB", - "type": [ "string" ] }, - { "name": "TYPE_X25", - "type": [ "string" ] }, - { "name": "TYPE_ISDN", - "type": [ "string" ] }, - { "name": "TYPE_RT", - "type": [ "string" ] }, - { "name": "TYPE_NSAP", - "type": [ "string" ] }, - { "name": "TYPE_NSAP_PTR", - "type": [ "string" ] }, - { "name": "TYPE_SIG", - "type": [ "string" ] }, - { "name": "TYPE_KEY", - "type": [ "string" ] }, - { "name": "TYPE_PX", - "type": [ "string" ] }, - { "name": "TYPE_GPOS", - "type": [ "string" ] }, - { "name": "TYPE_AAAA", - "type": [ "string" ] }, - { "name": "TYPE_LOC", - "type": [ "string" ] }, - { "name": "TYPE_NXT", - "type": [ "string" ] }, - { "name": "TYPE_EID", - "type": [ "string" ] }, - { "name": "TYPE_NIMLOC", - "type": [ "string" ] }, - { "name": "TYPE_SRV", - "type": [ "string" ] }, - { "name": "TYPE_ATMA", - "type": [ "string" ] }, - { "name": "TYPE_NAPTR", - "type": [ "string" ] }, - { "name": "TYPE_KX", - "type": [ "string" ] }, - { "name": "TYPE_CERT", - "type": [ "string" ] }, - { "name": "TYPE_A6", - "type": [ "string" ] }, - { "name": "TYPE_DNAME", - "type": [ "string" ] }, - { "name": "TYPE_SINK", - "type": [ "string" ] }, - { "name": "TYPE_OPT", - "type": [ "string" ] }, - { "name": "TYPE_APL", - "type": [ "string" ] }, - { "name": "TYPE_DS", - "type": [ "string" ] }, - { "name": "TYPE_SSHFP", - "type": [ "string" ] }, - { "name": "TYPE_IPSECKEY", - "type": [ "string" ] }, - { "name": "TYPE_RRSIG", - "type": [ "string" ] }, - { "name": "TYPE_NSEC", - "type": [ "string" ] }, - { "name": "TYPE_DNSKEY", - "type": [ "string" ] }, - { "name": "TYPE_SPF", - "type": [ "string" ] }, - { "name": "TYPE_UINFO", - "type": [ "string" ] }, - { "name": "TYPE_UID", - "type": [ "string" ] }, - { "name": "TYPE_GID", - "type": [ "string" ] }, - { "name": "TYPE_UNSPEC", - "type": [ "string" ] }, - { "name": "TYPE_TKEY", - "type": [ "string" ] }, - { "name": "TYPE_TSIG", - "type": [ "string" ] }, - { "name": "TYPE_MAILB", - "type": [ "string" ] }, - { "name": "TYPE_MAILA", - "type": [ "string" ] }, - { "name": "TYPE_GENERIC", - "type": [ "string" ] }, - { "name": "CLASS_IN", - "type": [ "string" ] }, - { "name": "CLASS_CS", - "type": [ "string" ] }, - { "name": "CLASS_CH", - "type": [ "string" ] }, - { "name": "CLASS_HS", - "type": [ "string" ] } ] } } }, - { "value": - { "name": "Dns.Dnsparser.zfile", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|16678" }, - "info": "", - "type": "(Lexing.lexbuf -> Dns.Dnsparser.token) -> Lexing.lexbuf -> unit", - "params": [ - { "name": "", - "type": "Lexing.lexbuf -> Dns.Dnsparser.token" }, - { "name": "", - "type": "Lexing.lexbuf" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Dnsserver", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|16747" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Dns.Dnsserver.load_zone", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|16772" }, - "info": "", - "type": "string list -> string -> unit", - "params": [ - { "name": "", - "type": "string list" }, - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Dns.Server", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|16822" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Dns.Server.listen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dns.mli|16965" }, - "info": "", - "type": "?mode:[< `leaky | `none > `none ] ->\n zonebuf:string ->\n Net.Datagram.UDPv4.mgr -> Net.Datagram.UDPv4.src -> unit Lwt.t", - "params": [ - { "name": "mode", - "type": "[< `leaky | `none > `none ] option" }, - { "name": "zonebuf", - "type": "string" }, - { "name": "", - "type": "Net.Datagram.UDPv4.mgr" }, - { "name": "", - "type": "Net.Datagram.UDPv4.src" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ "Net", "Lwt", "Lexing", "Hashtbl", "Bitstring", "*predef*" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Dyntype.json b/data/Dyntype.json deleted file mode 100644 index 98c54f2..0000000 --- a/data/Dyntype.json +++ /dev/null @@ -1,188 +0,0 @@ -{ "module": - { "name": "Dyntype", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|0" }, - "info": - { "description": "Dynamic types" }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Dyntype.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|832" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Unit", - "description": "unit", - "type": [ ] }, - { "name": "Bool", - "description": "booleans", - "type": [ ] }, - { "name": "Float", - "description": "floating-point numbers", - "type": [ ] }, - { "name": "Char", - "description": "characters", - "type": [ ] }, - { "name": "String", - "description": "strings", - "type": [ ] }, - { "name": "Int", - "description": "integer type of a given size (as 31-,32- or 64-bits); Int None is for bigints", - "type": [ "int option" ] }, - { "name": "List", - "description": "collection of stuff of the same type (stored as lists)", - "type": [ "Dyntype.t" ] }, - { "name": "Array", - "description": "collection of stuff of the same type (stored as arrays)", - "type": [ "Dyntype.t" ] }, - { "name": "Tuple", - "description": "Cartesian product", - "type": [ "Dyntype.t list" ] }, - { "name": "Dict", - "description": "record 'R or object 'O type; `RW stands for mutable fields", - "type": [ "[ `O | `R ]", "(string * [ `RO | `RW ] * Dyntype.t) list" ] }, - { "name": "Sum", - "description": "polymorphic `P or normal `N variant type", - "type": [ "[ `N | `P ]", "(string * Dyntype.t list) list" ] }, - { "name": "Option", - "description": "option type", - "type": [ "Dyntype.t" ] }, - { "name": "Rec", - "description": "recursive type", - "type": [ "string", "Dyntype.t" ] }, - { "name": "Var", - "description": "recursive fix-point", - "type": [ "string" ] }, - { "name": "Arrow", - "description": "arrow type", - "type": [ "Dyntype.t", "Dyntype.t" ] }, - { "name": "Ext", - "description": "type variable", - "type": [ "string", "Dyntype.t" ] } ] } } }, - { "comment": "

Utility functions

" }, - { "value": - { "name": "Dyntype.is_mutable", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|1794" }, - "info": - { "description": "is_mutable t checks whether t contains a mutable field" }, - "type": "Dyntype.t -> bool", - "params": [ - { "name": "", - "type": "Dyntype.t" } ] } }, - { "value": - { "name": "Dyntype.free_vars", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|1990" }, - "info": - { "description": "free_vars t returns all the free variables of type t. If t is unfolded (as it should be when calling type_of_t, this call should return an empty list." }, - "type": "Dyntype.t -> string list", - "params": [ - { "name": "", - "type": "Dyntype.t" } ] } }, - { "value": - { "name": "Dyntype.foreigns", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|2093" }, - "info": - { "description": "foreigns t returns all the type variables appearing in t." }, - "type": "Dyntype.t -> string list", - "params": [ - { "name": "", - "type": "Dyntype.t" } ] } }, - { "value": - { "name": "Dyntype.unroll", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|2221" }, - "info": - { "description": "unroll env t replaces every type appearing in t by its type value defined in env." }, - "type": "(string * Dyntype.t) list -> Dyntype.t -> Dyntype.t", - "params": [ - { "name": "", - "type": "(string * Dyntype.t) list" }, - { "name": "", - "type": "Dyntype.t" } ] } }, - { "comment": "

Sub-typing

" }, - { "value": - { "name": "Dyntype.is_subtype_of", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|2551" }, - "info": - { "description": "is_subtype_of s t checks whether s is a sub-type of t. Sub-typing relation is based on naming. Basically, s is a sub-type of t if (i) named attributes have either compatible types (ii) or some fields/methods defined in t do not appear in s." }, - "type": "Dyntype.t -> Dyntype.t -> bool", - "params": [ - { "name": "", - "type": "Dyntype.t" }, - { "name": "", - "type": "Dyntype.t" } ] } }, - { "value": - { "name": "Dyntype.(<:)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|2642" }, - "info": - { "description": "s <: t is a short-cut for is_subtype_of s t" }, - "type": "Dyntype.t -> Dyntype.t -> bool", - "params": [ - { "name": "", - "type": "Dyntype.t" }, - { "name": "", - "type": "Dyntype.t" } ] } }, - { "value": - { "name": "Dyntype.string_of_last_type_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|2764" }, - "info": - { "description": "Returns the more recent failing sub-type relation tested by (<:) or is_subtype_of" }, - "type": "unit -> string", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "

Pretty-printing

" }, - { "value": - { "name": "Dyntype.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|2888" }, - "info": - { "description": "to_string t pretty-prints the type t" }, - "type": "Dyntype.t -> string", - "params": [ - { "name": "", - "type": "Dyntype.t" } ] } }, - { "exception": - { "name": "Dyntype.Parse_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|2970" }, - "info": - { "description": "Exception that may be raised by !of_string" }, - "exception_args": [ "string" ] } }, - { "value": - { "name": "Dyntype.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/dyntype.mli|3145" }, - "info": - { "description": "of_string str returns the type t corresponding to the pretty-printed string str. Raises !Parse_error if is not a valid string" }, - "type": "string -> Dyntype.t", - "params": [ - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Format.json b/data/Format.json deleted file mode 100644 index d569324..0000000 --- a/data/Format.json +++ /dev/null @@ -1,1398 +0,0 @@ -{ "module": - { "name": "Format", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|0" }, - "info": - { "description": "Pretty printing.

This module implements a pretty-printing facility to format text within ``pretty-printing boxes''. The pretty-printer breaks lines at specified break hints, and indents lines according to the box structure.

For a gentle introduction to the basics of pretty-printing using Format, read http://caml.inria.fr/resources/doc/guides/format.html.

You may consider this module as providing an extension to the printf facility to provide automatic line breaking. The addition of pretty-printing annotations to your regular printf formats gives you fancy indentation and line breaks. Pretty-printing annotations are described below in the documentation of the function Format.fprintf.

You may also use the explicit box management and printing functions provided by this module. This style is more basic but more verbose than the fprintf concise formats.

For instance, the sequence open_box 0; print_string \"x =\"; print_space (); print_int 1; close_box (); print_newline () that prints x = 1 within a pretty-printing box, can be abbreviated as printf \"@[%s@ %i@]@.\" \"x =\" 1, or even shorter printf \"@[x =@ %i@]@.\" 1.

Rule of thumb for casual users of this library: The behaviour of pretty-printing commands is unspecified if there is no opened pretty-printing box. Each box opened via one of the open_ functions below must be closed using close_box for proper formatting. Otherwise, some of the material printed in the boxes may not be output, or may be formatted incorrectly.

In case of interactive use, the system closes all opened boxes and flushes all pending text (as with the print_newline function) after each phrase. Each phrase is therefore executed in the initial state of the pretty-printer.

Warning: the material output by the following functions is delayed in the pretty-printer queue in order to compute the proper line breaking. Hence, you should not mix calls to the printing functions of the basic I/O system with calls to the functions of this module: this could result in some strange output seemingly unrelated with the evaluation order of printing commands." }, - "type": "sig end", - "module_structure": [ - { "comment": "Pretty printing.

This module implements a pretty-printing facility to format text within ``pretty-printing boxes''. The pretty-printer breaks lines at specified break hints, and indents lines according to the box structure.

For a gentle introduction to the basics of pretty-printing using Format, read http://caml.inria.fr/resources/doc/guides/format.html.

You may consider this module as providing an extension to the printf facility to provide automatic line breaking. The addition of pretty-printing annotations to your regular printf formats gives you fancy indentation and line breaks. Pretty-printing annotations are described below in the documentation of the function Format.fprintf.

You may also use the explicit box management and printing functions provided by this module. This style is more basic but more verbose than the fprintf concise formats.

For instance, the sequence open_box 0; print_string \"x =\"; print_space (); print_int 1; close_box (); print_newline () that prints x = 1 within a pretty-printing box, can be abbreviated as printf \"@[%s@ %i@]@.\" \"x =\" 1, or even shorter printf \"@[x =@ %i@]@.\" 1.

Rule of thumb for casual users of this library: The behaviour of pretty-printing commands is unspecified if there is no opened pretty-printing box. Each box opened via one of the open_ functions below must be closed using close_box for proper formatting. Otherwise, some of the material printed in the boxes may not be output, or may be formatted incorrectly.

In case of interactive use, the system closes all opened boxes and flushes all pending text (as with the print_newline function) after each phrase. Each phrase is therefore executed in the initial state of the pretty-printer.

Warning: the material output by the following functions is delayed in the pretty-printer queue in order to compute the proper line breaking. Hence, you should not mix calls to the printing functions of the basic I/O system with calls to the functions of this module: this could result in some strange output seemingly unrelated with the evaluation order of printing commands." }, - { "comment": "
Boxes
" }, - { "value": - { "name": "Format.open_box", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|3842" }, - "info": - { "description": "open_box d opens a new pretty-printing box with offset d. This box is the general purpose pretty-printing box. Material in this box is displayed ``horizontal or vertical'': break hints inside the box may lead to a new line, if there is no more room on the line to print the remainder of the box, or if a new line may lead to a new indentation (demonstrating the indentation of the box). When a new line is printed in the box, d is added to the current indentation." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.close_box", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|4377" }, - "info": - { "description": "Closes the most recently opened pretty-printing box." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Formatting functions
" }, - { "value": - { "name": "Format.print_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|4502" }, - "info": - { "description": "print_string str prints str in the current box." }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Format.print_as", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|4598" }, - "info": - { "description": "print_as len str prints str in the current box. The pretty-printer formats str as if it were of length len." }, - "type": "int -> string -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Format.print_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|4767" }, - "info": - { "description": "Prints an integer in the current box." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.print_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|4843" }, - "info": - { "description": "Prints a floating point number in the current box." }, - "type": "float -> unit", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Format.print_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|4936" }, - "info": - { "description": "Prints a character in the current box." }, - "type": "char -> unit", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Format.print_bool", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|5015" }, - "info": - { "description": "Prints a boolean in the current box." }, - "type": "bool -> unit", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "comment": "
Break hints
" }, - { "value": - { "name": "Format.print_space", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|5116" }, - "info": - { "description": "print_space () is used to separate items (typically to print a space between two words). It indicates that the line may be split at this point. It either prints one space or splits the line. It is equivalent to print_break 1 0." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.print_cut", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|5401" }, - "info": - { "description": "print_cut () is used to mark a good break position. It indicates that the line may be split at this point. It either prints nothing or splits the line. This allows line splitting at the current point, without printing spaces or adding indentation. It is equivalent to print_break 0 0." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.print_break", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|5744" }, - "info": - { "description": "Inserts a break hint in a pretty-printing box. print_break nspaces offset indicates that the line may be split (a newline character is printed) at this point, if the contents of the current box does not fit on the current line. If the line is split at that point, offset is added to the current indentation. If the line is not split, nspaces spaces are printed." }, - "type": "int -> int -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.print_flush", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|6180" }, - "info": - { "description": "Flushes the pretty printer: all opened boxes are closed, and all pending text is displayed." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.print_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|6316" }, - "info": - { "description": "Equivalent to print_flush followed by a new line." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.force_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|6411" }, - "info": - { "description": "Forces a newline in the current box. Not the normal way of pretty-printing, you should prefer break hints." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.print_if_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|6564" }, - "info": - { "description": "Executes the next formatting command if the preceding line has just been split. Otherwise, ignore the next formatting command." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Margin
" }, - { "value": - { "name": "Format.set_margin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|6762" }, - "info": - { "description": "set_margin d sets the value of the right margin to d (in characters): this value is used to detect line overflows that leads to split lines. Nothing happens if d is smaller than 2. If d is too large, the right margin is set to the maximum admissible value (which is greater than 10^10)." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.get_margin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|7113" }, - "info": - { "description": "Returns the position of the right margin." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Maximum indentation limit
" }, - { "value": - { "name": "Format.set_max_indent", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|7232" }, - "info": - { "description": "set_max_indent d sets the value of the maximum indentation limit to d (in characters): once this limit is reached, boxes are rejected to the left, if they do not fit on the current line. Nothing happens if d is smaller than 2. If d is too large, the limit is set to the maximum admissible value (which is greater than 10^10)." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.get_max_indent", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|7629" }, - "info": - { "description": "Return the value of the maximum indentation limit (in characters)." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Formatting depth: maximum number of boxes allowed before ellipsis
" }, - { "value": - { "name": "Format.set_max_boxes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|7817" }, - "info": - { "description": "set_max_boxes max sets the maximum number of boxes simultaneously opened. Material inside boxes nested deeper is printed as an ellipsis (more precisely as the text returned by get_ellipsis_text ()). Nothing happens if max is smaller than 2." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.get_max_boxes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|8121" }, - "info": - { "description": "Returns the maximum number of boxes allowed before ellipsis." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.over_max_boxes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|8224" }, - "info": - { "description": "Tests if the maximum number of boxes allowed have already been opened." }, - "type": "unit -> bool", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Advanced formatting
" }, - { "value": - { "name": "Format.open_hbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|8371" }, - "info": - { "description": "open_hbox () opens a new pretty-printing box. This box is ``horizontal'': the line is not split in this box (new lines may still occur inside boxes nested deeper)." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.open_vbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|8582" }, - "info": - { "description": "open_vbox d opens a new pretty-printing box with offset d. This box is ``vertical'': every break hint inside this box leads to a new line. When a new line is printed in the box, d is added to the current indentation." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.open_hvbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|8858" }, - "info": - { "description": "open_hvbox d opens a new pretty-printing box with offset d. This box is ``horizontal-vertical'': it behaves as an ``horizontal'' box if it fits on a single line, otherwise it behaves as a ``vertical'' box. When a new line is printed in the box, d is added to the current indentation." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.open_hovbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|9205" }, - "info": - { "description": "open_hovbox d opens a new pretty-printing box with offset d. This box is ``horizontal or vertical'': break hints inside this box may lead to a new line, if there is no more room on the line to print the remainder of the box. When a new line is printed in the box, d is added to the current indentation." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "comment": "
Tabulations
" }, - { "value": - { "name": "Format.open_tbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|9596" }, - "info": - { "description": "Opens a tabulation box." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.close_tbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|9659" }, - "info": - { "description": "Closes the most recently opened tabulation box." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.print_tbreak", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|9747" }, - "info": - { "description": "Break hint in a tabulation box. print_tbreak spaces offset moves the insertion point to the next tabulation (spaces being added to this position). Nothing occurs if insertion point is already on a tabulation mark. If there is no next tabulation on the line, then a newline is printed and the insertion point moves to the first tabulation of the box. If a new line is printed, offset is added to the current indentation." }, - "type": "int -> int -> unit", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.set_tab", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|10248" }, - "info": - { "description": "Sets a tabulation mark at the current insertion point." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.print_tab", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|10340" }, - "info": - { "description": "print_tab () is equivalent to print_tbreak 0 0." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Ellipsis
" }, - { "value": - { "name": "Format.set_ellipsis_text", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|10452" }, - "info": - { "description": "Set the text of the ellipsis printed when too many boxes are opened (a single dot, ., by default)." }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Format.get_ellipsis_text", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|10605" }, - "info": - { "description": "Return the text of the ellipsis." }, - "type": "unit -> string", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Semantics Tags
" }, - { "type": - { "name": "Format.tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|10724" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string" } }, - { "comment": "Semantics tags (or simply tags) are used to decorate printed entities for user's defined purposes, e.g. setting font and giving size indications for a display device, or marking delimitation of semantics entities (e.g. HTML or TeX elements or terminal escape sequences).

By default, those tags do not influence line breaking calculation: the tag ``markers'' are not considered as part of the printing material that drives line breaking (in other words, the length of those strings is considered as zero for line breaking).

Thus, tag handling is in some sense transparent to pretty-printing and does not interfere with usual pretty-printing. Hence, a single pretty printing routine can output both simple ``verbatim'' material or richer decorated output depending on the treatment of tags. By default, tags are not active, hence the output is not decorated with tag information. Once set_tags is set to true, the pretty printer engine honours tags and decorates the output accordingly.

When a tag has been opened (or closed), it is both and successively ``printed'' and ``marked''. Printing a tag means calling a formatter specific function with the name of the tag as argument: that ``tag printing'' function can then print any regular material to the formatter (so that this material is enqueued as usual in the formatter queue for further line-breaking computation). Marking a tag means to output an arbitrary string (the ``tag marker''), directly into the output device of the formatter. Hence, the formatter specific ``tag marking'' function must return the tag marker string associated to its tag argument. Being flushed directly into the output device of the formatter, tag marker strings are not considered as part of the printing material that drives line breaking (in other words, the length of the strings corresponding to tag markers is considered as zero for line breaking). In addition, advanced users may take advantage of the specificity of tag markers to be precisely output when the pretty printer has already decided where to break the lines, and precisely when the queue is flushed into the output device.

In the spirit of HTML tags, the default tag marking functions output tags enclosed in \"<\" and \">\": hence, the opening marker of tag t is \"<t>\" and the closing marker \"</t>\".

Default tag printing functions just do nothing.

Tag marking and tag printing functions are user definable and can be set by calling set_formatter_tag_functions." }, - { "value": - { "name": "Format.open_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|13351" }, - "info": - { "description": "open_tag t opens the tag named t; the print_open_tag function of the formatter is called with t as argument; the tag marker mark_open_tag t will be flushed into the output device of the formatter." }, - "type": "Format.tag -> unit", - "params": [ - { "name": "", - "type": "Format.tag" } ] } }, - { "value": - { "name": "Format.close_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|13603" }, - "info": - { "description": "close_tag () closes the most recently opened tag t. In addition, the print_close_tag function of the formatter is called with t as argument. The marker mark_close_tag t will be flushed into the output device of the formatter." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.set_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|13887" }, - "info": - { "description": "set_tags b turns on or off the treatment of tags (default is off)." }, - "type": "bool -> unit", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Format.set_print_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|13993" }, - "info": "", - "type": "bool -> unit", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Format.set_mark_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|14029" }, - "info": - { "description": "set_print_tags b turns on or off the printing of tags, while set_mark_tags b turns on or off the output of tag markers." }, - "type": "bool -> unit", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Format.get_print_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|14199" }, - "info": "", - "type": "unit -> bool", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.get_mark_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|14235" }, - "info": - { "description": "Return the current status of tags printing and tags marking." }, - "type": "unit -> bool", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Redirecting the standard formatter output
" }, - { "value": - { "name": "Format.set_formatter_out_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|14393" }, - "info": - { "description": "Redirect the pretty-printer output to the given channel. (All the output functions of the standard formatter are set to the default output functions printing to the given channel.)" }, - "type": "Pervasives.out_channel -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Format.set_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|14656" }, - "info": - { "description": "set_formatter_output_functions out flush redirects the relevant pretty-printer output functions to the functions out and flush.

The out function performs the pretty-printer string output. It is called with a string s, a start position p, and a number of characters n; it is supposed to output characters p to p + n - 1 of s. The flush function is called whenever the pretty-printer is flushed (via conversion %!, pretty-printing indications @? or @., or using low level function print_flush or print_newline)." }, - "type": "(string -> int -> int -> unit) -> (unit -> unit) -> unit", - "params": [ - { "name": "", - "type": "string -> int -> int -> unit" }, - { "name": "", - "type": "unit -> unit" } ] } }, - { "value": - { "name": "Format.get_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|15330" }, - "info": - { "description": "Return the current output functions of the pretty-printer." }, - "type": "unit -> (string -> int -> int -> unit) * (unit -> unit)", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Changing the meaning of standard formatter pretty printing
" }, - { "comment": "The Format module is versatile enough to let you completely redefine the meaning of pretty printing: you may provide your own functions to define how to handle indentation, line breaking, and even printing of all the characters that have to be printed!" }, - { "value": - { "name": "Format.set_all_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|15840" }, - "info": - { "description": "set_all_formatter_output_functions out flush outnewline outspace redirects the pretty-printer output to the functions out and flush as described in set_formatter_output_functions. In addition, the pretty-printer function that outputs a newline is set to the function outnewline and the function that outputs indentation spaces is set to the function outspace.

This way, you can change the meaning of indentation (which can be something else than just printing space characters) and the meaning of new lines opening (which can be connected to any other action needed by the application at hand). The two functions outspace and outnewline are normally connected to out and flush: respective default values for outspace and outnewline are out (String.make n ' ') 0 n and out \"\\n\" 0 1." }, - "type": "out:(string -> int -> int -> unit) ->\n flush:(unit -> unit) ->\n newline:(unit -> unit) -> spaces:(int -> unit) -> unit", - "params": [ - { "name": "out", - "type": "string -> int -> int -> unit" }, - { "name": "flush", - "type": "unit -> unit" }, - { "name": "newline", - "type": "unit -> unit" }, - { "name": "spaces", - "type": "int -> unit" } ] } }, - { "value": - { "name": "Format.get_all_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|16866" }, - "info": - { "description": "Return the current output functions of the pretty-printer, including line breaking and indentation functions. Useful to record the current setting and restore it afterwards." }, - "type": "unit ->\n (string -> int -> int -> unit) * (unit -> unit) * (unit -> unit) *\n (int -> unit)", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Changing the meaning of printing semantics tags
" }, - { "type": - { "name": "Format.formatter_tag_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|17267" }, - "info": - { "description": "The tag handling functions specific to a formatter: mark versions are the ``tag marking'' functions that associate a string marker to a tag in order for the pretty-printing engine to flush those markers as 0 length tokens in the output device of the formatter. print versions are the ``tag printing'' functions that can perform regular printing when a tag is closed or opened." }, - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "mark_open_tag", - "mutable": false, - "type": "Format.tag -> string" }, - { "name": "mark_close_tag", - "mutable": false, - "type": "Format.tag -> string" }, - { "name": "print_open_tag", - "mutable": false, - "type": "Format.tag -> unit" }, - { "name": "print_close_tag", - "mutable": false, - "type": "Format.tag -> unit" } ] } } }, - { "value": - { "name": "Format.set_formatter_tag_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|17836" }, - "info": "", - "type": "Format.formatter_tag_functions -> unit", - "params": [ - { "name": "", - "type": "Format.formatter_tag_functions" } ] } }, - { "comment": "set_formatter_tag_functions tag_funs changes the meaning of opening and closing tags to use the functions in tag_funs.

When opening a tag name t, the string t is passed to the opening tag marking function (the mark_open_tag field of the record tag_funs), that must return the opening tag marker for that name. When the next call to close_tag () happens, the tag name t is sent back to the closing tag marking function (the mark_close_tag field of record tag_funs), that must return a closing tag marker for that name.

The print_ field of the record contains the functions that are called at tag opening and tag closing time, to output regular material in the pretty-printer queue." }, - { "value": - { "name": "Format.get_formatter_tag_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|18654" }, - "info": - { "description": "Return the current tag functions of the pretty-printer." }, - "type": "unit -> Format.formatter_tag_functions", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Multiple formatted output
" }, - { "type": - { "name": "Format.formatter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|18832" }, - "info": - { "description": "Abstract data corresponding to a pretty-printer (also called a formatter) and all its machinery.

Defining new pretty-printers permits unrelated output of material in parallel on several output channels. All the parameters of a pretty-printer are local to this pretty-printer: margin, maximum indentation limit, maximum number of boxes simultaneously opened, ellipsis, and so on, are specific to each pretty-printer and may be fixed independently. Given a Pervasives.out_channel output channel oc, a new formatter writing to that channel is simply obtained by calling formatter_of_out_channel oc. Alternatively, the make_formatter function allocates a new formatter with explicit output and flushing functions (convenient to output material to strings for instance)." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Format.formatter_of_out_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|19653" }, - "info": - { "description": "formatter_of_out_channel oc returns a new formatter that writes to the corresponding channel oc." }, - "type": "Pervasives.out_channel -> Format.formatter", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Format.std_formatter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|19823" }, - "info": - { "description": "The standard formatter used by the formatting functions above. It is defined as formatter_of_out_channel stdout." }, - "type": "Format.formatter", - "params": [ ] } }, - { "value": - { "name": "Format.err_formatter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|19981" }, - "info": - { "description": "A formatter to use with formatting functions below for output to standard error. It is defined as formatter_of_out_channel stderr." }, - "type": "Format.formatter", - "params": [ ] } }, - { "value": - { "name": "Format.formatter_of_buffer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|20160" }, - "info": - { "description": "formatter_of_buffer b returns a new formatter writing to buffer b. As usual, the formatter has to be flushed at the end of pretty printing, using pp_print_flush or pp_print_newline, to display all the pending material." }, - "type": "Buffer.t -> Format.formatter", - "params": [ - { "name": "", - "type": "Buffer.t" } ] } }, - { "value": - { "name": "Format.stdbuf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|20454" }, - "info": - { "description": "The string buffer in which str_formatter writes." }, - "type": "Buffer.t", - "params": [ ] } }, - { "value": - { "name": "Format.str_formatter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|20537" }, - "info": - { "description": "A formatter to use with formatting functions below for output to the stdbuf string buffer. str_formatter is defined as formatter_of_buffer stdbuf." }, - "type": "Format.formatter", - "params": [ ] } }, - { "value": - { "name": "Format.flush_str_formatter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|20736" }, - "info": - { "description": "Returns the material printed with str_formatter, flushes the formatter and resets the corresponding buffer." }, - "type": "unit -> string", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.make_formatter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|20900" }, - "info": - { "description": "make_formatter out flush returns a new formatter that writes according to the output function out, and the flushing function flush. For instance, a formatter to the Pervasives.out_channel oc is returned by make_formatter (Pervasives.output oc) (fun () -> Pervasives.flush oc)." }, - "type": "(string -> int -> int -> unit) -> (unit -> unit) -> Format.formatter", - "params": [ - { "name": "", - "type": "string -> int -> int -> unit" }, - { "name": "", - "type": "unit -> unit" } ] } }, - { "comment": "
Basic functions to use with formatters
" }, - { "value": - { "name": "Format.pp_open_hbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21342" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_open_vbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21389" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_open_hvbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21435" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_open_hovbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21482" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_open_box", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21530" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_close_box", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21575" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_open_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21622" }, - "info": "", - "type": "Format.formatter -> string -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Format.pp_close_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21670" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_print_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21717" }, - "info": "", - "type": "Format.formatter -> string -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Format.pp_print_as", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21769" }, - "info": "", - "type": "Format.formatter -> int -> string -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Format.pp_print_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21824" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_print_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21870" }, - "info": "", - "type": "Format.formatter -> float -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Format.pp_print_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21920" }, - "info": "", - "type": "Format.formatter -> char -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Format.pp_print_bool", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|21968" }, - "info": "", - "type": "Format.formatter -> bool -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Format.pp_print_break", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22016" }, - "info": "", - "type": "Format.formatter -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_print_cut", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22071" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_print_space", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22118" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_force_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22167" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_print_flush", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22218" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_print_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22267" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_print_if_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22318" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_open_tbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22372" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_close_tbox", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22419" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_print_tbreak", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22467" }, - "info": "", - "type": "Format.formatter -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_set_tab", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22523" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_print_tab", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22568" }, - "info": "", - "type": "Format.formatter -> unit -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22615" }, - "info": "", - "type": "Format.formatter -> bool -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Format.pp_set_print_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22661" }, - "info": "", - "type": "Format.formatter -> bool -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Format.pp_set_mark_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22713" }, - "info": "", - "type": "Format.formatter -> bool -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Format.pp_get_print_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22764" }, - "info": "", - "type": "Format.formatter -> unit -> bool", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_get_mark_tags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22816" }, - "info": "", - "type": "Format.formatter -> unit -> bool", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_margin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22867" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_get_margin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22914" }, - "info": "", - "type": "Format.formatter -> unit -> int", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_max_indent", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|22961" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_get_max_indent", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23012" }, - "info": "", - "type": "Format.formatter -> unit -> int", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_max_boxes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23063" }, - "info": "", - "type": "Format.formatter -> int -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Format.pp_get_max_boxes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23113" }, - "info": "", - "type": "Format.formatter -> unit -> int", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_over_max_boxes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23163" }, - "info": "", - "type": "Format.formatter -> unit -> bool", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_ellipsis_text", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23215" }, - "info": "", - "type": "Format.formatter -> string -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Format.pp_get_ellipsis_text", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23272" }, - "info": "", - "type": "Format.formatter -> unit -> string", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_formatter_out_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23329" }, - "info": "", - "type": "Format.formatter -> Pervasives.out_channel -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Format.pp_set_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23410" }, - "info": "", - "type": "Format.formatter -> (string -> int -> int -> unit) -> (unit -> unit) -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "string -> int -> int -> unit" }, - { "name": "", - "type": "unit -> unit" } ] } }, - { "value": - { "name": "Format.pp_get_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23525" }, - "info": "", - "type": "Format.formatter -> unit -> (string -> int -> int -> unit) * (unit -> unit)", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_all_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23639" }, - "info": "", - "type": "Format.formatter ->\n out:(string -> int -> int -> unit) ->\n flush:(unit -> unit) ->\n newline:(unit -> unit) -> spaces:(int -> unit) -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "out", - "type": "string -> int -> int -> unit" }, - { "name": "flush", - "type": "unit -> unit" }, - { "name": "newline", - "type": "unit -> unit" }, - { "name": "spaces", - "type": "int -> unit" } ] } }, - { "value": - { "name": "Format.pp_get_all_formatter_output_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23820" }, - "info": "", - "type": "Format.formatter ->\n unit ->\n (string -> int -> int -> unit) * (unit -> unit) * (unit -> unit) *\n (int -> unit)", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Format.pp_set_formatter_tag_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|23975" }, - "info": "", - "type": "Format.formatter -> Format.formatter_tag_functions -> unit", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "Format.formatter_tag_functions" } ] } }, - { "value": - { "name": "Format.pp_get_formatter_tag_functions", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|24062" }, - "info": - { "description": "These functions are the basic ones: usual functions operating on the standard formatter are defined via partial evaluation of these primitives. For instance, print_string is equal to pp_print_string std_formatter." }, - "type": "Format.formatter -> unit -> Format.formatter_tag_functions", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "unit" } ] } }, - { "comment": "
printf like functions for pretty-printing.
" }, - { "value": - { "name": "Format.fprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|24441" }, - "info": "", - "type": "Format.formatter -> ('a, Format.formatter, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "('a, Format.formatter, unit) Pervasives.format" } ] } }, - { "comment": "fprintf ff fmt arg1 ... argN formats the arguments arg1 to argN according to the format string fmt, and outputs the resulting string on the formatter ff.

The format fmt is a character string which contains three types of objects: plain characters and conversion specifications as specified in the Printf module, and pretty-printing indications specific to the Format module.

The pretty-printing indication characters are introduced by a @ character, and their meanings are: Example: printf \"@[%s@ %d@]@.\" \"x =\" 1 is equivalent to open_box (); print_string \"x =\"; print_space (); print_int 1; close_box (); print_newline (). It prints x = 1 within a pretty-printing box." }, - { "value": - { "name": "Format.printf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|27740" }, - "info": - { "description": "Same as fprintf above, but output on std_formatter." }, - "type": "('a, Format.formatter, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "('a, Format.formatter, unit) Pervasives.format" } ] } }, - { "value": - { "name": "Format.eprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|27854" }, - "info": - { "description": "Same as fprintf above, but output on err_formatter." }, - "type": "('a, Format.formatter, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "('a, Format.formatter, unit) Pervasives.format" } ] } }, - { "value": - { "name": "Format.sprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|27969" }, - "info": - { "description": "Same as printf above, but instead of printing on a formatter, returns a string containing the result of formatting the arguments. Note that the pretty-printer queue is flushed at the end of each call to sprintf.

In case of multiple and related calls to sprintf to output material on a single string, you should consider using fprintf with the predefined formatter str_formatter and call flush_str_formatter () to get the final result.

Alternatively, you can use Format.fprintf with a formatter writing to a buffer of your own: flushing the formatter and the buffer at the end of pretty-printing returns the desired string." }, - "type": "('a, unit, string) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "('a, unit, string) Pervasives.format" } ] } }, - { "value": - { "name": "Format.ifprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|28698" }, - "info": - { "description": "Same as fprintf above, but does not print anything. Useful to ignore some material when conditionally printing.", - "since": "3.10.0" }, - "type": "Format.formatter -> ('a, Format.formatter, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "('a, Format.formatter, unit) Pervasives.format" } ] } }, - { "comment": "Formatted output functions with continuations." }, - { "value": - { "name": "Format.kfprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|28960" }, - "info": - { "description": "Same as fprintf above, but instead of returning immediately, passes the formatter to its first argument at the end of printing." }, - "type": "(Format.formatter -> 'a) ->\n Format.formatter -> ('b, Format.formatter, unit, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "Format.formatter -> 'a" }, - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "('a, Format.formatter, unit, 'b) Pervasives.format4" } ] } }, - { "value": - { "name": "Format.ikfprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|29207" }, - "info": - { "description": "Same as kfprintf above, but does not print anything. Useful to ignore some material when conditionally printing.", - "since": "3.12.0" }, - "type": "(Format.formatter -> 'a) ->\n Format.formatter -> ('b, Format.formatter, unit, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "Format.formatter -> 'a" }, - { "name": "", - "type": "Format.formatter" }, - { "name": "", - "type": "('a, Format.formatter, unit, 'b) Pervasives.format4" } ] } }, - { "value": - { "name": "Format.ksprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|29457" }, - "info": - { "description": "Same as sprintf above, but instead of returning the string, passes it to the first argument." }, - "type": "(string -> 'a) -> ('b, unit, string, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "string -> 'a" }, - { "name": "", - "type": "('a, unit, string, 'b) Pervasives.format4" } ] } }, - { "comment": "
Deprecated
" }, - { "value": - { "name": "Format.bprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|29658" }, - "info": - { "description": "Deprecated and error prone function. Do not use it.

If you need to print to some buffer b, you must first define a formatter writing to b, using let to_b = formatter_of_buffer b; then use regular calls to Format.fprintf on formatter to_b." }, - "type": "Buffer.t -> ('a, Format.formatter, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "('a, Format.formatter, unit) Pervasives.format" } ] } }, - { "value": - { "name": "Format.kprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/format.mli|29985" }, - "info": - { "description": "Deprecated name. A synonym for ksprintf." }, - "type": "(string -> 'a) -> ('b, unit, string, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "string -> 'a" }, - { "name": "", - "type": "('a, unit, string, 'b) Pervasives.format4" } ] } } ], - "dependencies": - { "uses": [ "Pervasives", "Buffer" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Gc.json b/data/Gc.json deleted file mode 100644 index f10ef33..0000000 --- a/data/Gc.json +++ /dev/null @@ -1,306 +0,0 @@ -{ "module": - { "name": "Gc", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|0" }, - "info": - { "description": "Memory management control and statistics; finalised values." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Gc.stat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|1018" }, - "info": - { "description": "The memory management counters are returned in a stat record.

The total amount of memory allocated by the program since it was started is (in words) minor_words + major_words - promoted_words. Multiply by the word size (4 on a 32-bit machine, 8 on a 64-bit machine) to get the number of bytes." }, - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "minor_words", - "mutable": false, - "description": "Number of words allocated in the minor heap since the program was started. This number is accurate in byte-code programs, but only an approximation in programs compiled to native code.", - "type": "float" }, - { "name": "promoted_words", - "mutable": false, - "description": "Number of words allocated in the minor heap that survived a minor collection and were moved to the major heap since the program was started.", - "type": "float" }, - { "name": "major_words", - "mutable": false, - "description": "Number of words allocated in the major heap, including the promoted words, since the program was started.", - "type": "float" }, - { "name": "minor_collections", - "mutable": false, - "description": "Number of minor collections since the program was started.", - "type": "int" }, - { "name": "major_collections", - "mutable": false, - "description": "Number of major collection cycles completed since the program was started.", - "type": "int" }, - { "name": "heap_words", - "mutable": false, - "description": "Total size of the major heap, in words.", - "type": "int" }, - { "name": "heap_chunks", - "mutable": false, - "description": "Number of contiguous pieces of memory that make up the major heap.", - "type": "int" }, - { "name": "live_words", - "mutable": false, - "description": "Number of words of live data in the major heap, including the header words.", - "type": "int" }, - { "name": "live_blocks", - "mutable": false, - "description": "Number of live blocks in the major heap.", - "type": "int" }, - { "name": "free_words", - "mutable": false, - "description": "Number of words in the free list.", - "type": "int" }, - { "name": "free_blocks", - "mutable": false, - "description": "Number of blocks in the free list.", - "type": "int" }, - { "name": "largest_free", - "mutable": false, - "description": "Size (in words) of the largest block in the free list.", - "type": "int" }, - { "name": "fragments", - "mutable": false, - "description": "Number of wasted words due to fragmentation. These are 1-words free blocks placed between two live blocks. They are not available for allocation.", - "type": "int" }, - { "name": "compactions", - "mutable": false, - "description": "Number of heap compactions since the program was started.", - "type": "int" }, - { "name": "top_heap_words", - "mutable": false, - "description": "Maximum size reached by the major heap, in words.", - "type": "int" }, - { "name": "stack_size", - "mutable": false, - "description": "Current size of the stack, in words.", - "type": "int" } ] } } }, - { "type": - { "name": "Gc.control", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|3222" }, - "info": - { "description": "The GC parameters are given as a control record. Note that these parameters can also be initialised by setting the OCAMLRUNPARAM environment variable. See the documentation of ocamlrun." }, - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "minor_heap_size", - "mutable": true, - "description": "The size (in words) of the minor heap. Changing this parameter will trigger a minor collection. Default: 32k.", - "type": "int" }, - { "name": "major_heap_increment", - "mutable": true, - "description": "The minimum number of words to add to the major heap when increasing it. Default: 124k.", - "type": "int" }, - { "name": "space_overhead", - "mutable": true, - "description": "The major GC speed is computed from this parameter. This is the memory that will be \"wasted\" because the GC does not immediatly collect unreachable blocks. It is expressed as a percentage of the memory used for live data. The GC will work more (use more CPU time and collect blocks more eagerly) if space_overhead is smaller. Default: 80.", - "type": "int" }, - { "name": "verbose", - "mutable": true, - "description": "This value controls the GC messages on standard error output. It is a sum of some of the following flags, to print messages on the corresponding events:", - "type": "int" }, - { "name": "max_overhead", - "mutable": true, - "description": "Heap compaction is triggered when the estimated amount of \"wasted\" memory is more than max_overhead percent of the amount of live data. If max_overhead is set to 0, heap compaction is triggered at the end of each major GC cycle (this setting is intended for testing purposes only). If max_overhead >= 1000000, compaction is never triggered. Default: 500.", - "type": "int" }, - { "name": "stack_limit", - "mutable": true, - "description": "The maximum size of the stack (in words). This is only relevant to the byte-code runtime, as the native code runtime uses the operating system's stack. Default: 256k.", - "type": "int" }, - { "name": "allocation_policy", - "mutable": true, - "description": "The policy used for allocating in the heap. Possible values are 0 and 1. 0 is the next-fit policy, which is quite fast but can result in fragmentation. 1 is the first-fit policy, which can be slower in some cases but can be better for programs with fragmentation problems. Default: 0.", - "type": "int" } ] } } }, - { "value": - { "name": "Gc.stat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|5991" }, - "info": - { "description": "Return the current values of the memory management counters in a stat record. This function examines every heap block to get the statistics." }, - "type": "unit -> Gc.stat", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.quick_stat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|6195" }, - "info": - { "description": "Same as stat except that live_words, live_blocks, free_words, free_blocks, largest_free, and fragments are set to 0. This function is much faster than stat because it does not need to go through the heap." }, - "type": "unit -> Gc.stat", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.counters", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|6495" }, - "info": - { "description": "Return (minor_words, promoted_words, major_words). This function is as fast at quick_stat." }, - "type": "unit -> float * float * float", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|6674" }, - "info": - { "description": "Return the current values of the GC parameters in a control record." }, - "type": "unit -> Gc.control", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.set", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|6799" }, - "info": - { "description": "set r changes the GC parameters according to the control record r. The normal usage is: Gc.set { (Gc.get()) with Gc.verbose = 0x00d }" }, - "type": "Gc.control -> unit", - "params": [ - { "name": "", - "type": "Gc.control" } ] } }, - { "value": - { "name": "Gc.minor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|6999" }, - "info": - { "description": "Trigger a minor collection." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.major_slice", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|7083" }, - "info": - { "description": "Do a minor collection and a slice of major collection. The argument is the size of the slice, 0 to use the automatically-computed slice size. In all cases, the result is the computed slice size." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Gc.major", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|7356" }, - "info": - { "description": "Do a minor collection and finish the current major collection cycle." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.full_major", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|7481" }, - "info": - { "description": "Do a minor collection, finish the current major collection cycle, and perform a complete new cycle. This will collect all currently unreachable blocks." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.compact", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|7706" }, - "info": - { "description": "Perform a full major collection and compact the heap. Note that heap compaction is a lengthy operation." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.allocated_bytes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|7877" }, - "info": - { "description": "Return the total number of bytes allocated since the program was started. It is returned as a float to avoid overflow problems with int on 32-bit machines." }, - "type": "unit -> float", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Gc.finalise", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|8088" }, - "info": - { "description": "finalise f v registers f as a finalisation function for v. v must be heap-allocated. f will be called with v as argument at some point between the first time v becomes unreachable and the time v is collected by the GC. Several functions can be registered for the same value, or even several instances of the same function. Each instance will be called once (or never, if the program terminates before v becomes unreachable).

The GC will call the finalisation functions in the order of deallocation. When several values become unreachable at the same time (i.e. during the same GC cycle), the finalisation functions will be called in the reverse order of the corresponding calls to finalise. If finalise is called in the same order as the values are allocated, that means each value is finalised before the values it depends upon. Of course, this becomes false if additional dependencies are introduced by assignments.

Anything reachable from the closure of finalisation functions is considered reachable, so the following code will not work as expected: Instead you should write: The f function can use all features of O'Caml, including assignments that make the value reachable again. It can also loop forever (in this case, the other finalisation functions will not be called during the execution of f, unless it calls finalise_release). It can call finalise on v or other values to register other functions or even itself. It can raise an exception; in this case the exception will interrupt whatever the program was doing when the function was called.

finalise will raise Invalid_argument if v is not heap-allocated. Some examples of values that are not heap-allocated are integers, constant constructors, booleans, the empty array, the empty list, the unit value. The exact list of what is heap-allocated or not is implementation-dependent. Some constant values can be heap-allocated but never deallocated during the lifetime of the program, for example a list of integer constants; this is also implementation-dependent. You should also be aware that compiler optimisations may duplicate some immutable values, for example floating-point numbers when stored into arrays, so they can be finalised and collected while another copy is still in use by the program.

The results of calling String.make, String.create, Array.make, and Pervasives.ref are guaranteed to be heap-allocated and non-constant except when the length argument is 0." }, - "type": "('a -> unit) -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Gc.finalise_release", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|10890" }, - "info": - { "description": "A finalisation function may call finalise_release to tell the GC that it can launch the next finalisation function without waiting for the current one to return." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "type": - { "name": "Gc.alarm", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|11113" }, - "info": - { "description": "An alarm is a piece of data that calls a user function at the end of each major GC cycle. The following functions are provided to create and delete alarms." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Gc.create_alarm", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|11290" }, - "info": - { "description": "create_alarm f will arrange for f to be called at the end of each major GC cycle, starting with the current cycle or the next one. A value of type alarm is returned that you can use to call delete_alarm." }, - "type": "(unit -> unit) -> Gc.alarm", - "params": [ - { "name": "", - "type": "unit -> unit" } ] } }, - { "value": - { "name": "Gc.delete_alarm", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/gc.mli|11562" }, - "info": - { "description": "delete_alarm a will stop the calls to the function associated to a. Calling delete_alarm a again has no effect." }, - "type": "Gc.alarm -> unit", - "params": [ - { "name": "", - "type": "Gc.alarm" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Hashtbl.json b/data/Hashtbl.json deleted file mode 100644 index 32be5fa..0000000 --- a/data/Hashtbl.json +++ /dev/null @@ -1,247 +0,0 @@ -{ "module": - { "name": "Hashtbl", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|0" }, - "info": - { "description": "Hash tables and hash functions.

Hash tables are hashed association tables, with in-place modification." }, - "type": "sig end", - "module_structure": [ - { "comment": "
Generic interface
" }, - { "type": - { "name": "Hashtbl.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|1101" }, - "info": - { "description": "The type of hash tables from type 'a to type 'b." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" }, - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Hashtbl.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|1173" }, - "info": - { "description": "Hashtbl.create n creates a new, empty hash table, with initial size n. For best results, n should be on the order of the expected number of elements that will be in the table. The table grows as needed, so n is just an initial guess." }, - "type": "int -> ('a, 'b) Hashtbl.t", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Hashtbl.clear", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|1468" }, - "info": - { "description": "Empty a hash table." }, - "type": "('a, 'b) Hashtbl.t -> unit", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" } ] } }, - { "value": - { "name": "Hashtbl.add", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|1528" }, - "info": - { "description": "Hashtbl.add tbl x y adds a binding of x to y in table tbl. Previous bindings for x are not removed, but simply hidden. That is, after performing Hashtbl.remove tbl x, the previous binding for x, if any, is restored. (Same behavior as with association lists.)" }, - "type": "('a, 'b) Hashtbl.t -> 'a -> 'b -> unit", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|1865" }, - "info": - { "description": "Return a copy of the given hashtable." }, - "type": "('a, 'b) Hashtbl.t -> ('a, 'b) Hashtbl.t", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" } ] } }, - { "value": - { "name": "Hashtbl.find", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|1947" }, - "info": - { "description": "Hashtbl.find tbl x returns the current binding of x in tbl, or raises Not_found if no such binding exists." }, - "type": "('a, 'b) Hashtbl.t -> 'a -> 'b", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.find_all", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|2107" }, - "info": - { "description": "Hashtbl.find_all tbl x returns the list of all data associated with x in tbl. The current binding is returned first, then the previous bindings, in reverse order of introduction in the table." }, - "type": "('a, 'b) Hashtbl.t -> 'a -> 'b list", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.mem", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|2365" }, - "info": - { "description": "Hashtbl.mem tbl x checks if x is bound in tbl." }, - "type": "('a, 'b) Hashtbl.t -> 'a -> bool", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.remove", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|2461" }, - "info": - { "description": "Hashtbl.remove tbl x removes the current binding of x in tbl, restoring the previous binding if it exists. It does nothing if x is not bound in tbl." }, - "type": "('a, 'b) Hashtbl.t -> 'a -> unit", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.replace", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|2672" }, - "info": - { "description": "Hashtbl.replace tbl x y replaces the current binding of x in tbl by a binding of x to y. If x is unbound in tbl, a binding of x to y is added to tbl. This is functionally equivalent to Hashtbl.remove tbl x followed by Hashtbl.add tbl x y." }, - "type": "('a, 'b) Hashtbl.t -> 'a -> 'b -> unit", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|3007" }, - "info": - { "description": "Hashtbl.iter f tbl applies f to all bindings in table tbl. f receives the key as first argument, and the associated value as second argument. Each binding is presented exactly once to f. The order in which the bindings are passed to f is unspecified. However, if the table contains several bindings for the same key, they are passed to f in reverse order of introduction, that is, the most recent binding is passed first." }, - "type": "('a -> 'b -> unit) -> ('a, 'b) Hashtbl.t -> unit", - "params": [ - { "name": "", - "type": "'a -> 'b -> unit" }, - { "name": "", - "type": "('a, 'b) Hashtbl.t" } ] } }, - { "value": - { "name": "Hashtbl.fold", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|3521" }, - "info": - { "description": "Hashtbl.fold f tbl init computes (f kN dN ... (f k1 d1 init)...), where k1 ... kN are the keys of all bindings in tbl, and d1 ... dN are the associated values. Each binding is presented exactly once to f. The order in which the bindings are passed to f is unspecified. However, if the table contains several bindings for the same key, they are passed to f in reverse order of introduction, that is, the most recent binding is passed first." }, - "type": "('a -> 'b -> 'c -> 'c) -> ('a, 'b) Hashtbl.t -> 'c -> 'c", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'c -> 'c" }, - { "name": "", - "type": "('a, 'b) Hashtbl.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|4070" }, - "info": - { "description": "Hashtbl.length tbl returns the number of bindings in tbl. Multiple bindings are counted multiply, so Hashtbl.length gives the number of times Hashtbl.iter calls its first argument." }, - "type": "('a, 'b) Hashtbl.t -> int", - "params": [ - { "name": "", - "type": "('a, 'b) Hashtbl.t" } ] } }, - { "comment": "
Functorial interface
" }, - { "module_type": - { "name": "Hashtbl.HashedType", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|4339" }, - "info": - { "description": "The input signature of the functor Hashtbl.Make." }, - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Hashtbl.S", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|5224" }, - "info": - { "description": "The output signature of the functor Hashtbl.Make." }, - "type": "sig end", - "kind": "" } }, - { "module": - { "name": "Hashtbl.Make", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|5795" }, - "info": - { "description": "Functor building an implementation of the hashtable structure. The functor Hashtbl.Make returns a structure containing a type key of keys and a type 'a t of hash tables associating data of type 'a to keys of type key. The operations perform similarly to those of the generic interface, but use the hashing and equality functions specified in the functor argument H instead of generic equality and hashing." }, - "type": "functor (H : HashedType) -> sig end", - "module_functor": - { "parameter": - { "name": "H" }, - "module_with": "unavailable" }, - "dependencies": - { "uses": [ ] } } }, - { "comment": "
The polymorphic hash primitive
" }, - { "value": - { "name": "Hashtbl.hash", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|6347" }, - "info": - { "description": "Hashtbl.hash x associates a positive integer to any value of any type. It is guaranteed that if x = y or Pervasives.compare x y = 0, then hash x = hash y. Moreover, hash always terminates, even on cyclic structures." }, - "type": "'a -> int", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Hashtbl.hash_param", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/hashtbl.mli|6614" }, - "info": - { "description": "Hashtbl.hash_param n m x computes a hash value for x, with the same properties as for hash. The two extra parameters n and m give more precise control over hashing. Hashing performs a depth-first, right-to-left traversal of the structure x, stopping after n meaningful nodes were encountered, or m nodes, meaningful or not, were encountered. Meaningful nodes are: integers; floating-point numbers; strings; characters; booleans; and constant constructors. Larger values of m and n means that more nodes are taken into account to compute the final hash value, and therefore collisions are less likely to happen. However, hashing takes longer. The parameters m and n govern the tradeoff between accuracy and speed." }, - "type": "int -> int -> 'a -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Weak", "Dns", "Http" ] } } } \ No newline at end of file diff --git a/data/Http.json b/data/Http.json deleted file mode 100644 index 95e93a8..0000000 --- a/data/Http.json +++ /dev/null @@ -1,1532 +0,0 @@ -{ "module": - { "name": "Http", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|0" }, - "info": - { "description": "Type definitions" }, - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Http.Types", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Type definitions" }, - { "type": - { "name": "Http.Types.version", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|1061" }, - "info": - { "description": "HTTP version, actually only 1.0 and 1.1 are supported. Note that 'supported' here means only 'accepted inside a HTTP request line', no different behaviours are actually implemented depending on HTTP version" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `HTTP_1_0 | `HTTP_1_1 ]" } }, - { "type": - { "name": "Http.Types.meth", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|1180" }, - "info": - { "description": "HTTP method, actually only GET and POST methods are supported" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `DELETE | `GET | `HEAD | `POST ]" } }, - { "type": - { "name": "Http.Types.auth_info", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|1274" }, - "info": - { "description": "authentication information" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Basic of string * (string -> string -> bool) | `None ]" } }, - { "type": - { "name": "Http.Types.informational_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|1496" }, - "info": - { "see": [ - { "doc": "RFC2616", - "text": "informational HTTP status" } ] }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Continue | `Switching_protocols ]" } }, - { "type": - { "name": "Http.Types.success_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|1612" }, - "info": - { "see": [ - { "doc": "RFC2616", - "text": "success HTTP status" } ] }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Accepted\n | `Created\n | `No_content\n | `Non_authoritative_information\n | `OK\n | `Partial_content\n | `Reset_content ]" } }, - { "type": - { "name": "Http.Types.redirection_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|1813" }, - "info": - { "see": [ - { "doc": "RFC2616", - "text": "redirection HTTP status" } ] }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Found\n | `Moved_permanently\n | `Multiple_choices\n | `Not_modified\n | `See_other\n | `Temporary_redirect\n | `Use_proxy ]" } }, - { "type": - { "name": "Http.Types.client_error_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|2021" }, - "info": - { "see": [ - { "doc": "RFC2616", - "text": "client error HTTP status" } ] }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Bad_request\n | `Conflict\n | `Expectation_failed\n | `Forbidden\n | `Gone\n | `Length_required\n | `Method_not_allowed\n | `Not_acceptable\n | `Not_found\n | `Payment_required\n | `Precondition_failed\n | `Proxy_authentication_required\n | `Request_URI_too_large\n | `Request_entity_too_large\n | `Request_time_out\n | `Requested_range_not_satisfiable\n | `Unauthorized\n | `Unsupported_media_type ]" } }, - { "type": - { "name": "Http.Types.server_error_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|2506" }, - "info": - { "see": [ - { "doc": "RFC2616", - "text": "server error HTTP status" } ] }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Bad_gateway\n | `Gateway_time_out\n | `HTTP_version_not_supported\n | `Internal_server_error\n | `Not_implemented\n | `Service_unavailable ]" } }, - { "type": - { "name": "Http.Types.error_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|2682" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Bad_gateway\n | `Bad_request\n | `Conflict\n | `Expectation_failed\n | `Forbidden\n | `Gateway_time_out\n | `Gone\n | `HTTP_version_not_supported\n | `Internal_server_error\n | `Length_required\n | `Method_not_allowed\n | `Not_acceptable\n | `Not_found\n | `Not_implemented\n | `Payment_required\n | `Precondition_failed\n | `Proxy_authentication_required\n | `Request_URI_too_large\n | `Request_entity_too_large\n | `Request_time_out\n | `Requested_range_not_satisfiable\n | `Service_unavailable\n | `Unauthorized\n | `Unsupported_media_type ]" } }, - { "type": - { "name": "Http.Types.status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|2776" }, - "info": - { "description": "HTTP status" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Accepted\n | `Bad_gateway\n | `Bad_request\n | `Conflict\n | `Continue\n | `Created\n | `Expectation_failed\n | `Forbidden\n | `Found\n | `Gateway_time_out\n | `Gone\n | `HTTP_version_not_supported\n | `Internal_server_error\n | `Length_required\n | `Method_not_allowed\n | `Moved_permanently\n | `Multiple_choices\n | `No_content\n | `Non_authoritative_information\n | `Not_acceptable\n | `Not_found\n | `Not_implemented\n | `Not_modified\n | `OK\n | `Partial_content\n | `Payment_required\n | `Precondition_failed\n | `Proxy_authentication_required\n | `Request_URI_too_large\n | `Request_entity_too_large\n | `Request_time_out\n | `Requested_range_not_satisfiable\n | `Reset_content\n | `See_other\n | `Service_unavailable\n | `Switching_protocols\n | `Temporary_redirect\n | `Unauthorized\n | `Unsupported_media_type\n | `Use_proxy ]" } }, - { "type": - { "name": "Http.Types.status_code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|2910" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Accepted\n | `Bad_gateway\n | `Bad_request\n | `Code of int\n | `Conflict\n | `Continue\n | `Created\n | `Expectation_failed\n | `Forbidden\n | `Found\n | `Gateway_time_out\n | `Gone\n | `HTTP_version_not_supported\n | `Internal_server_error\n | `Length_required\n | `Method_not_allowed\n | `Moved_permanently\n | `Multiple_choices\n | `No_content\n | `Non_authoritative_information\n | `Not_acceptable\n | `Not_found\n | `Not_implemented\n | `Not_modified\n | `OK\n | `Partial_content\n | `Payment_required\n | `Precondition_failed\n | `Proxy_authentication_required\n | `Request_URI_too_large\n | `Request_entity_too_large\n | `Request_time_out\n | `Requested_range_not_satisfiable\n | `Reset_content\n | `See_other\n | `Service_unavailable\n | `Switching_protocols\n | `Temporary_redirect\n | `Unauthorized\n | `Unsupported_media_type\n | `Use_proxy ]" } }, - { "comment": "

Exceptions

" }, - { "exception": - { "name": "Http.Types.Invalid_header", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3012" }, - "info": - { "description": "invalid header encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Invalid_header_name", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3089" }, - "info": - { "description": "invalid header name encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Invalid_header_value", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3172" }, - "info": - { "description": "invalid header value encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Invalid_HTTP_version", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3271" }, - "info": - { "description": "unsupported or invalid HTTP version encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Invalid_HTTP_method", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3369" }, - "info": - { "description": "unsupported or invalid HTTP method encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Invalid_code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3479" }, - "info": - { "description": "invalid HTTP status code integer representation encountered" }, - "exception_args": [ "int" ] } }, - { "exception": - { "name": "Http.Types.Malformed_URL", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3543" }, - "info": - { "description": "invalid URL encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Malformed_query", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3620" }, - "info": - { "description": "invalid query string encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Malformed_query_part", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3756" }, - "info": - { "description": "invalid query string part encountered, arguments are parameter name and parameter value" }, - "exception_args": [ "string", "string" ] } }, - { "exception": - { "name": "Http.Types.Malformed_request_URI", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3848" }, - "info": - { "description": "invalid request URI encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Malformed_request", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|3927" }, - "info": - { "description": "malformed request received" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Malformed_response", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|4038" }, - "info": - { "description": "malformed response received, argument is response's first line" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Param_not_found", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|4134" }, - "info": - { "description": "a parameter you were looking for was not found" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Invalid_status_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|4217" }, - "info": - { "description": "invalid HTTP status line encountered" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Header_not_found", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|4312" }, - "info": - { "description": "an header you were looking for was not found" }, - "exception_args": [ "string" ] } }, - { "exception": - { "name": "Http.Types.Unauthorized", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|4590" }, - "info": - { "description": "raisable by callbacks to force a 401 (unauthorized) HTTP answer. This exception should be raised _before_ sending any data over given out channel." }, - "exception_args": [ "string" ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Misc", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|4627" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Helpers and other not better classified functions which should not be exposed in the final API" }, - { "value": - { "name": "Http.Misc.date_822", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|5654" }, - "info": - { "return": "the current date compliant to RFC 1123, which updates RFC 822 zone info are retrieved from UTC" }, - "type": "unit -> string", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Http.Misc.rfc822_of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|5752" }, - "info": - { "description": "Convert a number of seconds to a date compliant with RFC 822" }, - "type": "float -> string", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Http.Misc.strip_trailing_slash", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|5869" }, - "info": - { "description": "strip trailing '/', if any, from a string and", - "return": "the new string" }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Misc.strip_heading_slash", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|5990" }, - "info": - { "description": "strip heading '/', if any, from a string and", - "return": "the new string" }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Misc.reason_phrase_of_code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6109" }, - "info": - { "description": "given an HTTP response code return the corresponding reason phrase" }, - "type": "int -> string", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Misc.list_assoc_all", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6250" }, - "info": - { "description": "like List.assoc but return all bindings of a given key instead of the leftmost one only" }, - "type": "'a -> ('a * 'b) list -> 'b list", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "value": - { "name": "Http.Misc.warn", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6303" }, - "info": - { "description": "print a warning msg to stderr. Adds trailing \\n" }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Misc.error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6383" }, - "info": - { "description": "print an error msg to stderr. Adds trailing \\n" }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Url", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6468" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Http.Url.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6508" }, - "info": - { "description": "URL type" }, - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "scheme", - "mutable": false, - "type": "string option" }, - { "name": "userinfo", - "mutable": false, - "type": "string option" }, - { "name": "host", - "mutable": false, - "type": "string option" }, - { "name": "port", - "mutable": false, - "type": "int option" }, - { "name": "path", - "mutable": false, - "type": "string list option" }, - { "name": "path_string", - "mutable": false, - "type": "string option" }, - { "name": "query", - "mutable": false, - "type": "(string * string) list option" }, - { "name": "query_string", - "mutable": false, - "type": "string option" }, - { "name": "fragment", - "mutable": false, - "type": "string option" } ] } } }, - { "value": - { "name": "Http.Url.full_path", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6906" }, - "info": - { "description": "Get the full path of an url (ie. including leading /, queries and fragments" }, - "type": "Http.Url.t -> string", - "params": [ - { "name": "", - "type": "Http.Url.t" } ] } }, - { "value": - { "name": "Http.Url.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|6978" }, - "info": - { "description": "Build an encoded string from an URL" }, - "type": "Http.Url.t -> string", - "params": [ - { "name": "", - "type": "Http.Url.t" } ] } }, - { "value": - { "name": "Http.Url.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|7050" }, - "info": - { "description": "Build an URL from an encoded string" }, - "type": "string -> Http.Url.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Url.encode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|7108" }, - "info": - { "description": "URL encode the string" }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Url.decode", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|7168" }, - "info": - { "description": "URL decode the string" }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Common", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|7202" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Common functionalities shared by other OCaml HTTP modules" }, - { "value": - { "name": "Http.Common.string_of_version", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|8132" }, - "info": - { "description": "pretty print an HTTP version" }, - "type": "Http.Types.version -> string", - "params": [ - { "name": "", - "type": "Http.Types.version" } ] } }, - { "value": - { "name": "Http.Common.version_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|8310" }, - "info": - { "description": "parse an HTTP version from a string", - "raised_exceptions": [ - { "raised_exception": "Invalid_HTTP_version", - "text": "if given string doesn't represent a supported HTTP version" } ] }, - "type": "string -> Http.Types.version", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Common.string_of_method", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|8389" }, - "info": - { "description": "pretty print an HTTP method" }, - "type": "Http.Types.meth -> string", - "params": [ - { "name": "", - "type": "Http.Types.meth" } ] } }, - { "value": - { "name": "Http.Common.method_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|8555" }, - "info": - { "description": "parse an HTTP method from a string", - "raised_exceptions": [ - { "raised_exception": "Invalid_HTTP_method", - "text": "if given string doesn't represent a supported method" } ] }, - "type": "string -> Http.Types.meth", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Common.status_of_code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|8738" }, - "info": - { "description": "converts an integer HTTP status to the corresponding status value", - "raised_exceptions": [ - { "raised_exception": "Invalid_code", - "text": "if given integer isn't a valid HTTP status code" } ] }, - "type": "int -> Http.Types.status", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Common.code_of_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|8841" }, - "info": - { "description": "converts an HTTP status to the corresponding integer value" }, - "type": "[< Http.Types.status ] -> int", - "params": [ - { "name": "", - "type": "[< Http.Types.status ]" } ] } }, - { "value": - { "name": "Http.Common.is_informational", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|8951" }, - "info": - { "return": "true on \"informational\" status codes, false elsewhere" }, - "type": "int -> bool", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Common.is_success", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|9051" }, - "info": - { "return": "true on \"success\" status codes, false elsewhere" }, - "type": "int -> bool", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Common.is_redirection", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|9149" }, - "info": - { "return": "true on \"redirection\" status codes, false elsewhere" }, - "type": "int -> bool", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Common.is_client_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|9252" }, - "info": - { "return": "true on \"client error\" status codes, false elsewhere" }, - "type": "int -> bool", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Common.is_server_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|9356" }, - "info": - { "return": "true on \"server error\" status codes, false elsewhere" }, - "type": "int -> bool", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Common.is_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|9480" }, - "info": - { "return": "true on \"client error\" and \"server error\" status code, false elsewhere" }, - "type": "int -> bool", - "params": [ - { "name": "", - "type": "int" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Constants", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|9511" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Constants" }, - { "value": - { "name": "Http.Constants.default_version", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10344" }, - "info": "", - "type": "Http.Types.version", - "params": [ ] } }, - { "value": - { "name": "Http.Constants.server_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10380" }, - "info": "", - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Http.Constants.crlf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10407" }, - "info": "", - "type": "string", - "params": [ ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Message", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10428" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Http.Message.contents", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10454" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Inchan of int64 * Bitstring.t Lwt_stream.t | `String of string ]" } }, - { "type": - { "name": "Http.Message.message", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10543" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Http.Message.body", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10551" }, - "info": "", - "type": "Http.Message.message -> Http.Message.contents list", - "params": [ - { "name": "", - "type": "Http.Message.message" } ] } }, - { "value": - { "name": "Http.Message.body_size", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10587" }, - "info": "", - "type": "Http.Message.contents list -> int64", - "params": [ - { "name": "", - "type": "Http.Message.contents list" } ] } }, - { "value": - { "name": "Http.Message.set_body", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10626" }, - "info": "", - "type": "Http.Message.message -> Http.Message.contents -> unit", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "", - "type": "Http.Message.contents" } ] } }, - { "value": - { "name": "Http.Message.add_body", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10669" }, - "info": "", - "type": "Http.Message.message -> Http.Message.contents -> unit", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "", - "type": "Http.Message.contents" } ] } }, - { "value": - { "name": "Http.Message.add_header", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10712" }, - "info": "", - "type": "Http.Message.message -> name:string -> value:string -> unit", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "name", - "type": "string" }, - { "name": "value", - "type": "string" } ] } }, - { "value": - { "name": "Http.Message.add_headers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10776" }, - "info": "", - "type": "Http.Message.message -> (string * string) list -> unit", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "", - "type": "(string * string) list" } ] } }, - { "value": - { "name": "Http.Message.replace_header", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10836" }, - "info": "", - "type": "Http.Message.message -> name:string -> value:string -> unit", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "name", - "type": "string" }, - { "name": "value", - "type": "string" } ] } }, - { "value": - { "name": "Http.Message.replace_headers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10904" }, - "info": "", - "type": "Http.Message.message -> (string * string) list -> unit", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "", - "type": "(string * string) list" } ] } }, - { "value": - { "name": "Http.Message.remove_header", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|10968" }, - "info": "", - "type": "Http.Message.message -> name:string -> unit", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "name", - "type": "string" } ] } }, - { "value": - { "name": "Http.Message.has_header", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|11019" }, - "info": "", - "type": "Http.Message.message -> name:string -> bool", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "name", - "type": "string" } ] } }, - { "value": - { "name": "Http.Message.header", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|11067" }, - "info": "", - "type": "Http.Message.message -> name:string -> string list", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "name", - "type": "string" } ] } }, - { "value": - { "name": "Http.Message.headers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|11118" }, - "info": "", - "type": "Http.Message.message -> (string * string) list", - "params": [ - { "name": "", - "type": "Http.Message.message" } ] } }, - { "value": - { "name": "Http.Message.version", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|11166" }, - "info": "", - "type": "Http.Message.message -> Http.Types.version", - "params": [ - { "name": "", - "type": "Http.Message.message" } ] } }, - { "value": - { "name": "Http.Message.init", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|11205" }, - "info": "", - "type": "body:Http.Message.contents list ->\n headers:(string * string) list ->\n version:Http.Types.version -> Http.Message.message", - "params": [ - { "name": "body", - "type": "Http.Message.contents list" }, - { "name": "headers", - "type": "(string * string) list" }, - { "name": "version", - "type": "Http.Types.version" } ] } }, - { "value": - { "name": "Http.Message.serialize_to_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|11311" }, - "info": "", - "type": "Http.Message.message -> fstLineToString:string -> Net.Channel.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Http.Message.message" }, - { "name": "fstLineToString", - "type": "string" }, - { "name": "", - "type": "Net.Channel.t" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Parser", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|11409" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "HTTP messages parsing" }, - { "value": - { "name": "Http.Parser.parse_request_fst_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|12673" }, - "info": - { "description": "parse 1st line of an HTTP request", - "raised_exceptions": [ - { "raised_exception": "Malformed_request", - "text": "if request 1st linst isn't well formed" }, - { "raised_exception": "Malformed_request_URI", - "text": "if requested URI isn't well formed" } ], - "return": "a triple meth * url * version, meth is the HTTP method invoked, url is the requested url, version is the HTTP version specified or None if no version was specified" }, - "type": "(unit -> string Lwt.t) ->\n (Http.Types.meth * Http.Url.t * Http.Types.version) Lwt.t", - "params": [ - { "name": "", - "type": "unit -> string Lwt.t" } ] } }, - { "value": - { "name": "Http.Parser.parse_response_fst_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|12927" }, - "info": - { "description": "parse 1st line of an HTTP response ", - "raised_exceptions": [ - { "raised_exception": "Malformed_response", - "text": "if first line isn't well formed" } ] }, - "type": "(unit -> string Lwt.t) -> (Http.Types.version * Http.Types.status) Lwt.t", - "params": [ - { "name": "", - "type": "unit -> string Lwt.t" } ] } }, - { "value": - { "name": "Http.Parser.parse_headers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|13266" }, - "info": - { "description": "parse HTTP headers. Consumes also trailing CRLF at the end of header list", - "raised_exceptions": [ - { "raised_exception": "Invalid_header", - "text": "if a not well formed header is encountered" } ], - "return": "a list of pairs header_name * header_value" }, - "type": "(unit -> string Lwt.t) -> (string * string) list Lwt.t", - "params": [ - { "name": "", - "type": "unit -> string Lwt.t" } ] } }, - { "value": - { "name": "Http.Parser.parse_request", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|13581" }, - "info": - { "description": "given an input channel, reads from it a GET HTTP request and", - "return": "a pair <path, query_params> where path is a string representing the requested path and query_params is a list of pairs <name, value> (the GET parameters)" }, - "type": "(unit -> string Lwt.t) -> (string * (string * string) list) Lwt.t", - "params": [ - { "name": "", - "type": "unit -> string Lwt.t" } ] } }, - { "value": - { "name": "Http.Parser.parse_content_range", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|13793" }, - "info": - { "description": "parse content-range header in a request", - "return": "number of bytes to read, or None if all available should be read" }, - "type": "(string * string) list -> int option", - "params": [ - { "name": "", - "type": "(string * string) list" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Request", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|13859" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Http.Request.request", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|13904" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Http.Request.init_request", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|13912" }, - "info": "", - "type": "unit Lwt.u -> (unit -> string Lwt.t) -> Http.Request.request Lwt.t", - "params": [ - { "name": "", - "type": "unit Lwt.u" }, - { "name": "", - "type": "unit -> string Lwt.t" } ] } }, - { "value": - { "name": "Http.Request.meth", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|13985" }, - "info": "", - "type": "Http.Request.request -> Http.Types.meth", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.uri", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14018" }, - "info": "", - "type": "Http.Request.request -> string", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.path", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14046" }, - "info": "", - "type": "Http.Request.request -> string", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.body", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14075" }, - "info": "", - "type": "Http.Request.request -> Http.Message.contents list", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.param", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14119" }, - "info": "", - "type": "?meth:[< `GET | `POST ] ->\n ?default:string -> Http.Request.request -> string -> string", - "params": [ - { "name": "meth", - "type": "[< `GET | `POST ] option" }, - { "name": "default", - "type": "string option" }, - { "name": "", - "type": "Http.Request.request" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Request.param_all", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14207" }, - "info": "", - "type": "?meth:Http.Types.meth -> Http.Request.request -> string -> string list", - "params": [ - { "name": "meth", - "type": "Http.Types.meth option" }, - { "name": "", - "type": "Http.Request.request" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Request.params", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14276" }, - "info": "", - "type": "Http.Request.request -> (string, string) Hashtbl.t", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.params_get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14327" }, - "info": "", - "type": "Http.Request.request -> (string * string) list", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.params_post", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14378" }, - "info": "", - "type": "Http.Request.request -> (string * string) list", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.authorization", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14430" }, - "info": "", - "type": "Http.Request.request -> [> `Basic of string * string ] option", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } }, - { "value": - { "name": "Http.Request.header", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14499" }, - "info": "", - "type": "Http.Request.request -> name:string -> string list", - "params": [ - { "name": "", - "type": "Http.Request.request" }, - { "name": "name", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Response", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14554" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Http.Response.response", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14600" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Http.Response.init", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14609" }, - "info": "", - "type": "?body:Http.Message.contents list ->\n ?headers:(string * string) list ->\n ?version:Http.Types.version ->\n ?status:Http.Types.status_code ->\n ?reason:string -> unit -> Http.Response.response", - "params": [ - { "name": "body", - "type": "Http.Message.contents list option" }, - { "name": "headers", - "type": "(string * string) list option" }, - { "name": "version", - "type": "Http.Types.version option" }, - { "name": "status", - "type": "Http.Types.status_code option" }, - { "name": "reason", - "type": "string option" }, - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Http.Response.version_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14788" }, - "info": "", - "type": "Http.Response.response -> string", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14828" }, - "info": "", - "type": "Http.Response.response -> int", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14855" }, - "info": "", - "type": "Http.Response.response -> int -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Http.Response.status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14894" }, - "info": "", - "type": "Http.Response.response -> Http.Types.status", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14932" }, - "info": "", - "type": "Http.Response.response -> Http.Types.status -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "", - "type": "Http.Types.status" } ] } }, - { "value": - { "name": "Http.Response.reason", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|14982" }, - "info": "", - "type": "Http.Response.response -> string", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_reason", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15014" }, - "info": "", - "type": "Http.Response.response -> string -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Response.status_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15058" }, - "info": "", - "type": "Http.Response.response -> string", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.is_informational", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15095" }, - "info": "", - "type": "Http.Response.response -> bool", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.is_success", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15135" }, - "info": "", - "type": "Http.Response.response -> bool", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.is_redirection", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15169" }, - "info": "", - "type": "Http.Response.response -> bool", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.is_client_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15207" }, - "info": "", - "type": "Http.Response.response -> bool", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.is_server_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15246" }, - "info": "", - "type": "Http.Response.response -> bool", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.is_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15285" }, - "info": "", - "type": "Http.Response.response -> bool", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.add_basic_headers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15317" }, - "info": "", - "type": "Http.Response.response -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.content_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15358" }, - "info": "", - "type": "Http.Response.response -> string option", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_content_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15403" }, - "info": "", - "type": "Http.Response.response -> value:string -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "value", - "type": "string" } ] } }, - { "value": - { "name": "Http.Response.content_encoding", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15459" }, - "info": "", - "type": "Http.Response.response -> string option", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_content_encoding", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15508" }, - "info": "", - "type": "Http.Response.response -> value:string -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "value", - "type": "string" } ] } }, - { "value": - { "name": "Http.Response.date", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15568" }, - "info": "", - "type": "Http.Response.response -> string option", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_date", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15605" }, - "info": "", - "type": "Http.Response.response -> value:string -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "value", - "type": "string" } ] } }, - { "value": - { "name": "Http.Response.expires", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15653" }, - "info": "", - "type": "Http.Response.response -> string option", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_expires", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15693" }, - "info": "", - "type": "Http.Response.response -> value:string -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "value", - "type": "string" } ] } }, - { "value": - { "name": "Http.Response.server", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15744" }, - "info": "", - "type": "Http.Response.response -> string option", - "params": [ - { "name": "", - "type": "Http.Response.response" } ] } }, - { "value": - { "name": "Http.Response.set_server", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15783" }, - "info": "", - "type": "Http.Response.response -> value:string -> unit", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "value", - "type": "string" } ] } }, - { "value": - { "name": "Http.Response.serialize_to_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15833" }, - "info": "", - "type": "Http.Response.response -> Net.Channel.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Http.Response.response" }, - { "name": "", - "type": "Net.Channel.t" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Http.Cookie", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15904" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Http.Cookie.time", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|15929" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Day of int | `Hour of int | `Minute of int | `Second of int ] list" } }, - { "type": - { "name": "Http.Cookie.expiration", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|16015" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `Age of Http.Cookie.time | `Discard | `Session | `Until of float ]" } }, - { "type": - { "name": "Http.Cookie.cookie", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|16090" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Http.Cookie.make", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|16098" }, - "info": "", - "type": "?expiry:Http.Cookie.expiration ->\n ?path:string ->\n ?domain:string ->\n ?secure:bool -> string -> string -> string * Http.Cookie.cookie", - "params": [ - { "name": "expiry", - "type": "Http.Cookie.expiration option" }, - { "name": "path", - "type": "string option" }, - { "name": "domain", - "type": "string option" }, - { "name": "secure", - "type": "bool option" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Http.Cookie.serialize", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|16223" }, - "info": "", - "type": "?version:[ `HTTP_1_0 | `HTTP_1_1 ] ->\n string * Http.Cookie.cookie -> string * string", - "params": [ - { "name": "version", - "type": "[ `HTTP_1_0 | `HTTP_1_1 ] option" }, - { "tuple": - { "type": "string * Http.Cookie.cookie", - "contents": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "Http.Cookie.cookie" } ] } } ] } }, - { "value": - { "name": "Http.Cookie.extract", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/http.mli|16316" }, - "info": "", - "type": "Http.Request.request -> (string * string) list", - "params": [ - { "name": "", - "type": "Http.Request.request" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ "Net", "Lwt_stream", "Lwt", "Hashtbl", "Bitstring", "*predef*" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Int32.json b/data/Int32.json deleted file mode 100644 index 4736ad1..0000000 --- a/data/Int32.json +++ /dev/null @@ -1,368 +0,0 @@ -{ "module": - { "name": "Int32", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|0" }, - "info": - { "description": "32-bit integers.

This module provides operations on the type int32 of signed 32-bit integers. Unlike the built-in int type, the type int32 is guaranteed to be exactly 32-bit wide on all platforms. All arithmetic operations over int32 are taken modulo 232.

Performance notice: values of type int32 occupy more memory space than values of type int, and arithmetic operations on int32 are generally slower than those on int. Use int32 only when the application requires exact 32-bit arithmetic." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Int32.zero", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1500" }, - "info": - { "description": "The 32-bit integer 0." }, - "type": "int32", - "params": [ ] } }, - { "value": - { "name": "Int32.one", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1547" }, - "info": - { "description": "The 32-bit integer 1." }, - "type": "int32", - "params": [ ] } }, - { "value": - { "name": "Int32.minus_one", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1593" }, - "info": - { "description": "The 32-bit integer -1." }, - "type": "int32", - "params": [ ] } }, - { "value": - { "name": "Int32.neg", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1646" }, - "info": - { "description": "Unary negation." }, - "type": "int32 -> int32", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.add", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1715" }, - "info": - { "description": "Addition." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.sub", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1787" }, - "info": - { "description": "Subtraction." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.mul", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1862" }, - "info": - { "description": "Multiplication." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.div", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|1940" }, - "info": - { "description": "Integer division. Raise Division_by_zero if the second argument is zero. This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/)." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.rem", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2191" }, - "info": - { "description": "Integer remainder. If y is not zero, the result of Int32.rem x y satisfies the following property: x = Int32.add (Int32.mul (Int32.div x y) y) (Int32.rem x y). If y = 0, Int32.rem x y raises Division_by_zero." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.succ", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2484" }, - "info": - { "description": "Successor. Int32.succ x is Int32.add x Int32.one." }, - "type": "int32 -> int32", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.pred", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2573" }, - "info": - { "description": "Predecessor. Int32.pred x is Int32.sub x Int32.one." }, - "type": "int32 -> int32", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.abs", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2664" }, - "info": - { "description": "Return the absolute value of its argument." }, - "type": "int32 -> int32", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.max_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2740" }, - "info": - { "description": "The greatest representable 32-bit integer, 231 - 1." }, - "type": "int32", - "params": [ ] } }, - { "value": - { "name": "Int32.min_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2823" }, - "info": - { "description": "The smallest representable 32-bit integer, -231." }, - "type": "int32", - "params": [ ] } }, - { "value": - { "name": "Int32.logand", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2904" }, - "info": - { "description": "Bitwise logical and." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.logor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|2990" }, - "info": - { "description": "Bitwise logical or." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.logxor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|3073" }, - "info": - { "description": "Bitwise logical exclusive or." }, - "type": "int32 -> int32 -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.lognot", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|3168" }, - "info": - { "description": "Bitwise logical negation" }, - "type": "int32 -> int32", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.shift_left", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|3229" }, - "info": - { "description": "Int32.shift_left x y shifts x to the left by y bits. The result is unspecified if y < 0 or y >= 32." }, - "type": "int32 -> int -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int32.shift_right", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|3409" }, - "info": - { "description": "Int32.shift_right x y shifts x to the right by y bits. This is an arithmetic shift: the sign bit of x is replicated and inserted in the vacated bits. The result is unspecified if y < 0 or y >= 32." }, - "type": "int32 -> int -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int32.shift_right_logical", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|3695" }, - "info": - { "description": "Int32.shift_right_logical x y shifts x to the right by y bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of x. The result is unspecified if y < 0 or y >= 32." }, - "type": "int32 -> int -> int32", - "params": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int32.of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|3996" }, - "info": - { "description": "Convert the given integer (type int) to a 32-bit integer (type int32)." }, - "type": "int -> int32", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int32.to_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|4132" }, - "info": - { "description": "Convert the given 32-bit integer (type int32) to an integer (type int). On 32-bit platforms, the 32-bit integer is taken modulo 231, i.e. the high-order bit is lost during the conversion. On 64-bit platforms, the conversion is exact." }, - "type": "int32 -> int", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|4444" }, - "info": - { "description": "Convert the given floating-point number to a 32-bit integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [Int32.min_int, Int32.max_int]." }, - "type": "float -> int32", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Int32.to_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|4770" }, - "info": - { "description": "Convert the given 32-bit integer to a floating-point number." }, - "type": "int32 -> float", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|4898" }, - "info": - { "description": "Convert the given string to a 32-bit integer. The string is read in decimal (by default) or in hexadecimal, octal or binary if the string begins with 0x, 0o or 0b respectively. Raise Failure \"int_of_string\" if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integers representable in type int32." }, - "type": "string -> int32", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Int32.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|5357" }, - "info": - { "description": "Return the string representation of its argument, in signed decimal." }, - "type": "int32 -> string", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int32.bits_of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|5466" }, - "info": - { "description": "Return the internal representation of the given float according to the IEEE 754 floating-point ``single format'' bit layout. Bit 31 of the result represents the sign of the float; bits 30 to 23 represent the (biased) exponent; bits 22 to 0 represent the mantissa." }, - "type": "float -> int32", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Int32.float_of_bits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|5819" }, - "info": - { "description": "Return the floating-point number whose internal representation, according to the IEEE 754 floating-point ``single format'' bit layout, is the given int32." }, - "type": "int32 -> float", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "type": - { "name": "Int32.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|6064" }, - "info": - { "description": "An alias for the type of 32-bit integers." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int32" } }, - { "value": - { "name": "Int32.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int32.mli|6124" }, - "info": - { "description": "The comparison function for 32-bit integers, with the same specification as Pervasives.compare. Along with the type t, this function compare allows the module Int32 to be passed as argument to the functors Set.Make and Map.Make." }, - "type": "Int32.t -> Int32.t -> int", - "params": [ - { "name": "", - "type": "Int32.t" }, - { "name": "", - "type": "Int32.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Random", "Obj" ] } } } \ No newline at end of file diff --git a/data/Int64.json b/data/Int64.json deleted file mode 100644 index 0a4a062..0000000 --- a/data/Int64.json +++ /dev/null @@ -1,412 +0,0 @@ -{ "module": - { "name": "Int64", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|0" }, - "info": - { "description": "64-bit integers.

This module provides operations on the type int64 of signed 64-bit integers. Unlike the built-in int type, the type int64 is guaranteed to be exactly 64-bit wide on all platforms. All arithmetic operations over int64 are taken modulo 264

Performance notice: values of type int64 occupy more memory space than values of type int, and arithmetic operations on int64 are generally slower than those on int. Use int64 only when the application requires exact 64-bit arithmetic." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Int64.zero", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1499" }, - "info": - { "description": "The 64-bit integer 0." }, - "type": "int64", - "params": [ ] } }, - { "value": - { "name": "Int64.one", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1546" }, - "info": - { "description": "The 64-bit integer 1." }, - "type": "int64", - "params": [ ] } }, - { "value": - { "name": "Int64.minus_one", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1592" }, - "info": - { "description": "The 64-bit integer -1." }, - "type": "int64", - "params": [ ] } }, - { "value": - { "name": "Int64.neg", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1645" }, - "info": - { "description": "Unary negation." }, - "type": "int64 -> int64", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.add", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1714" }, - "info": - { "description": "Addition." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.sub", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1786" }, - "info": - { "description": "Subtraction." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.mul", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1861" }, - "info": - { "description": "Multiplication." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.div", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|1939" }, - "info": - { "description": "Integer division. Raise Division_by_zero if the second argument is zero. This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/)." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.rem", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2190" }, - "info": - { "description": "Integer remainder. If y is not zero, the result of Int64.rem x y satisfies the following property: x = Int64.add (Int64.mul (Int64.div x y) y) (Int64.rem x y). If y = 0, Int64.rem x y raises Division_by_zero." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.succ", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2483" }, - "info": - { "description": "Successor. Int64.succ x is Int64.add x Int64.one." }, - "type": "int64 -> int64", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.pred", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2572" }, - "info": - { "description": "Predecessor. Int64.pred x is Int64.sub x Int64.one." }, - "type": "int64 -> int64", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.abs", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2663" }, - "info": - { "description": "Return the absolute value of its argument." }, - "type": "int64 -> int64", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.max_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2739" }, - "info": - { "description": "The greatest representable 64-bit integer, 263 - 1." }, - "type": "int64", - "params": [ ] } }, - { "value": - { "name": "Int64.min_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2822" }, - "info": - { "description": "The smallest representable 64-bit integer, -263." }, - "type": "int64", - "params": [ ] } }, - { "value": - { "name": "Int64.logand", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2902" }, - "info": - { "description": "Bitwise logical and." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.logor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|2988" }, - "info": - { "description": "Bitwise logical or." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.logxor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|3071" }, - "info": - { "description": "Bitwise logical exclusive or." }, - "type": "int64 -> int64 -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.lognot", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|3166" }, - "info": - { "description": "Bitwise logical negation" }, - "type": "int64 -> int64", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.shift_left", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|3227" }, - "info": - { "description": "Int64.shift_left x y shifts x to the left by y bits. The result is unspecified if y < 0 or y >= 64." }, - "type": "int64 -> int -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int64.shift_right", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|3407" }, - "info": - { "description": "Int64.shift_right x y shifts x to the right by y bits. This is an arithmetic shift: the sign bit of x is replicated and inserted in the vacated bits. The result is unspecified if y < 0 or y >= 64." }, - "type": "int64 -> int -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int64.shift_right_logical", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|3693" }, - "info": - { "description": "Int64.shift_right_logical x y shifts x to the right by y bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of x. The result is unspecified if y < 0 or y >= 64." }, - "type": "int64 -> int -> int64", - "params": [ - { "name": "", - "type": "int64" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int64.of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|3994" }, - "info": - { "description": "Convert the given integer (type int) to a 64-bit integer (type int64)." }, - "type": "int -> int64", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Int64.to_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|4130" }, - "info": - { "description": "Convert the given 64-bit integer (type int64) to an integer (type int). On 64-bit platforms, the 64-bit integer is taken modulo 263, i.e. the high-order bit is lost during the conversion. On 32-bit platforms, the 64-bit integer is taken modulo 231, i.e. the top 33 bits are lost during the conversion." }, - "type": "int64 -> int", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|4516" }, - "info": - { "description": "Convert the given floating-point number to a 64-bit integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [Int64.min_int, Int64.max_int]." }, - "type": "float -> int64", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Int64.to_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|4842" }, - "info": - { "description": "Convert the given 64-bit integer to a floating-point number." }, - "type": "int64 -> float", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.of_int32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|4971" }, - "info": - { "description": "Convert the given 32-bit integer (type int32) to a 64-bit integer (type int64)." }, - "type": "int32 -> int64", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Int64.to_int32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|5121" }, - "info": - { "description": "Convert the given 64-bit integer (type int64) to a 32-bit integer (type int32). The 64-bit integer is taken modulo 232, i.e. the top 32 bits are lost during the conversion." }, - "type": "int64 -> int32", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.of_nativeint", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|5374" }, - "info": - { "description": "Convert the given native integer (type nativeint) to a 64-bit integer (type int64)." }, - "type": "nativeint -> int64", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Int64.to_nativeint", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|5540" }, - "info": - { "description": "Convert the given 64-bit integer (type int64) to a native integer. On 32-bit platforms, the 64-bit integer is taken modulo 232. On 64-bit platforms, the conversion is exact." }, - "type": "int64 -> nativeint", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|5805" }, - "info": - { "description": "Convert the given string to a 64-bit integer. The string is read in decimal (by default) or in hexadecimal, octal or binary if the string begins with 0x, 0o or 0b respectively. Raise Failure \"int_of_string\" if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integers representable in type int64." }, - "type": "string -> int64", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Int64.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|6264" }, - "info": - { "description": "Return the string representation of its argument, in decimal." }, - "type": "int64 -> string", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Int64.bits_of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|6366" }, - "info": - { "description": "Return the internal representation of the given float according to the IEEE 754 floating-point ``double format'' bit layout. Bit 63 of the result represents the sign of the float; bits 62 to 52 represent the (biased) exponent; bits 51 to 0 represent the mantissa." }, - "type": "float -> int64", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Int64.float_of_bits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|6719" }, - "info": - { "description": "Return the floating-point number whose internal representation, according to the IEEE 754 floating-point ``double format'' bit layout, is the given int64." }, - "type": "int64 -> float", - "params": [ - { "name": "", - "type": "int64" } ] } }, - { "type": - { "name": "Int64.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|6964" }, - "info": - { "description": "An alias for the type of 64-bit integers." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int64" } }, - { "value": - { "name": "Int64.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/int64.mli|7024" }, - "info": - { "description": "The comparison function for 64-bit integers, with the same specification as Pervasives.compare. Along with the type t, this function compare allows the module Int64 to be passed as argument to the functors Set.Make and Map.Make." }, - "type": "Int64.t -> Int64.t -> int", - "params": [ - { "name": "", - "type": "Int64.t" }, - { "name": "", - "type": "Int64.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Random" ] } } } \ No newline at end of file diff --git a/data/Lazy.json b/data/Lazy.json deleted file mode 100644 index 3a4cc7a..0000000 --- a/data/Lazy.json +++ /dev/null @@ -1,88 +0,0 @@ -{ "module": - { "name": "Lazy", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|0" }, - "info": - { "description": "Deferred computations." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Lazy.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|982" }, - "info": - { "description": "A value of type 'a Lazy.t is a deferred computation, called a suspension, that has a result of type 'a. The special expression syntax lazy (expr) makes a suspension of the computation of expr, without computing expr itself yet. \"Forcing\" the suspension will then compute expr and return its result.

Note: lazy_t is the built-in type constructor used by the compiler for the lazy keyword. You should not use it directly. Always use Lazy.t instead.

Note: Lazy.force is not thread-safe. If you use this module in a multi-threaded program, you will need to add some locks.

Note: if the program is compiled with the -rectypes option, ill-founded recursive definitions of the form let rec x = lazy x or let rec x = lazy(lazy(...(lazy x))) are accepted by the type-checker and lead, when forced, to ill-formed values that trigger infinite loops in the garbage collector and other parts of the run-time system. Without the -rectypes option, such ill-founded recursive definitions are rejected by the type-checker." }, - "params": [ - { "covariant": "true", - "contravariant": "false", - "type": "'a" } ], - "kind": - { "type": "abstract" }, - "manifest": "'a lazy_t" } }, - { "exception": - { "name": "Lazy.Undefined", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|2103" }, - "info": "" } }, - { "value": - { "name": "Lazy.force", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|2126" }, - "info": "", - "type": "'a Lazy.t -> 'a", - "params": [ - { "name": "", - "type": "'a Lazy.t" } ] } }, - { "comment": "force x forces the suspension x and returns its result. If x has already been forced, Lazy.force x returns the same value again without recomputing it. If it raised an exception, the same exception is raised again. Raise Undefined if the forcing of x tries to force x itself recursively." }, - { "value": - { "name": "Lazy.force_val", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|2530" }, - "info": - { "description": "force_val x forces the suspension x and returns its result. If x has already been forced, force_val x returns the same value again without recomputing it. Raise Undefined if the forcing of x tries to force x itself recursively. If the computation of x raises an exception, it is unspecified whether force_val x raises the same exception or Undefined." }, - "type": "'a Lazy.t -> 'a", - "params": [ - { "name": "", - "type": "'a Lazy.t" } ] } }, - { "value": - { "name": "Lazy.lazy_from_fun", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|2963" }, - "info": - { "description": "lazy_from_fun f is the same as lazy (f ()) but slightly more efficient." }, - "type": "(unit -> 'a) -> 'a Lazy.t", - "params": [ - { "name": "", - "type": "unit -> 'a" } ] } }, - { "value": - { "name": "Lazy.lazy_from_val", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|3094" }, - "info": - { "description": "lazy_from_val v returns an already-forced suspension of v This is for special purposes only and should not be confused with lazy (v)." }, - "type": "'a -> 'a Lazy.t", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lazy.lazy_is_val", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lazy.mli|3283" }, - "info": - { "description": "lazy_is_val x returns true if x has already been forced and did not raise an exception." }, - "type": "'a Lazy.t -> bool", - "params": [ - { "name": "", - "type": "'a Lazy.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lexing.json b/data/Lexing.json deleted file mode 100644 index d6b9b48..0000000 --- a/data/Lexing.json +++ /dev/null @@ -1,212 +0,0 @@ -{ "module": - { "name": "Lexing", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|0" }, - "info": - { "description": "The run-time library for lexers generated by ocamllex." }, - "type": "sig end", - "module_structure": [ - { "comment": "
Positions
" }, - { "type": - { "name": "Lexing.position", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|1041" }, - "info": - { "description": "A value of type position describes a point in a source file. pos_fname is the file name; pos_lnum is the line number; pos_bol is the offset of the beginning of the line (number of characters between the beginning of the file and the beginning of the line); pos_cnum is the offset of the position (number of characters between the beginning of the file and the position).

See the documentation of type lexbuf for information about how the lexing engine will manage positions." }, - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "pos_fname", - "mutable": false, - "type": "string" }, - { "name": "pos_lnum", - "mutable": false, - "type": "int" }, - { "name": "pos_bol", - "mutable": false, - "type": "int" }, - { "name": "pos_cnum", - "mutable": false, - "type": "int" } ] } } }, - { "value": - { "name": "Lexing.dummy_pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|1649" }, - "info": - { "description": "A value of type position, guaranteed to be different from any valid position." }, - "type": "Lexing.position", - "params": [ ] } }, - { "comment": "
Lexer buffers
" }, - { "type": - { "name": "Lexing.lexbuf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|1801" }, - "info": - { "description": "The type of lexer buffers. A lexer buffer is the argument passed to the scanning functions defined by the generated scanners. The lexer buffer holds the current state of the scanner, plus a function to refill the buffer from the input.

At each token, the lexing engine will copy lex_curr_p to lex_start_p, then change the pos_cnum field of lex_curr_p by updating it with the number of characters read since the start of the lexbuf. The other fields are left unchanged by the lexing engine. In order to keep them accurate, they must be initialised before the first use of the lexbuf, and updated by the relevant lexer actions (i.e. at each end of line -- see also new_line)." }, - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "refill_buff", - "mutable": false, - "type": "Lexing.lexbuf -> unit" }, - { "name": "lex_buffer", - "mutable": true, - "type": "string" }, - { "name": "lex_buffer_len", - "mutable": true, - "type": "int" }, - { "name": "lex_abs_pos", - "mutable": true, - "type": "int" }, - { "name": "lex_start_pos", - "mutable": true, - "type": "int" }, - { "name": "lex_curr_pos", - "mutable": true, - "type": "int" }, - { "name": "lex_last_pos", - "mutable": true, - "type": "int" }, - { "name": "lex_last_action", - "mutable": true, - "type": "int" }, - { "name": "lex_eof_reached", - "mutable": true, - "type": "bool" }, - { "name": "lex_mem", - "mutable": true, - "type": "int array" }, - { "name": "lex_start_p", - "mutable": true, - "type": "Lexing.position" }, - { "name": "lex_curr_p", - "mutable": true, - "type": "Lexing.position" } ] } } }, - { "value": - { "name": "Lexing.from_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|2949" }, - "info": - { "description": "Create a lexer buffer which reads from the given string. Reading starts from the first character in the string. An end-of-input condition is generated when the end of the string is reached." }, - "type": "string -> Lexing.lexbuf", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Lexing.from_function", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|3191" }, - "info": - { "description": "Create a lexer buffer with the given function as its reading method. When the scanner needs more characters, it will call the given function, giving it a character string s and a character count n. The function should put n characters or less in s, starting at character number 0, and return the number of characters provided. A return value of 0 means end of input." }, - "type": "(string -> int -> int) -> Lexing.lexbuf", - "params": [ - { "name": "", - "type": "string -> int -> int" } ] } }, - { "comment": "
Functions for lexer semantic actions
" }, - { "comment": "The following functions can be called from the semantic actions of lexer definitions (the ML code enclosed in braces that computes the value returned by lexing functions). They give access to the character string matched by the regular expression associated with the semantic action. These functions must be applied to the argument lexbuf, which, in the code generated by ocamllex, is bound to the lexer buffer passed to the parsing function." }, - { "value": - { "name": "Lexing.lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|4169" }, - "info": - { "description": "Lexing.lexeme lexbuf returns the string matched by the regular expression." }, - "type": "Lexing.lexbuf -> string", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" } ] } }, - { "value": - { "name": "Lexing.lexeme_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|4295" }, - "info": - { "description": "Lexing.lexeme_char lexbuf i returns character number i in the matched string." }, - "type": "Lexing.lexbuf -> int -> char", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Lexing.lexeme_start", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|4428" }, - "info": - { "description": "Lexing.lexeme_start lexbuf returns the offset in the input stream of the first character of the matched string. The first character of the stream has offset 0." }, - "type": "Lexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" } ] } }, - { "value": - { "name": "Lexing.lexeme_end", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|4637" }, - "info": - { "description": "Lexing.lexeme_end lexbuf returns the offset in the input stream of the character following the last character of the matched string. The first character of the stream has offset 0." }, - "type": "Lexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" } ] } }, - { "value": - { "name": "Lexing.lexeme_start_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|4865" }, - "info": - { "description": "Like lexeme_start, but return a complete position instead of an offset." }, - "type": "Lexing.lexbuf -> Lexing.position", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" } ] } }, - { "value": - { "name": "Lexing.lexeme_end_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|4993" }, - "info": - { "description": "Like lexeme_end, but return a complete position instead of an offset." }, - "type": "Lexing.lexbuf -> Lexing.position", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" } ] } }, - { "value": - { "name": "Lexing.new_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|5117" }, - "info": - { "description": "Update the lex_curr_p field of the lexbuf to reflect the start of a new line. You can call this function in the semantic action of the rule that matches the end-of-line character.", - "since": "3.11.0" }, - "type": "Lexing.lexbuf -> unit", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" } ] } }, - { "comment": "
Miscellaneous functions
" }, - { "value": - { "name": "Lexing.flush_input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lexing.mli|5400" }, - "info": - { "description": "Discard the contents of the buffer and reset the current position to 0. The next use of the lexbuf will trigger a refill." }, - "type": "Lexing.lexbuf -> unit", - "params": [ - { "name": "", - "type": "Lexing.lexbuf" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Parsing", "Dns" ] } } } \ No newline at end of file diff --git a/data/List.json b/data/List.json deleted file mode 100644 index 5860458..0000000 --- a/data/List.json +++ /dev/null @@ -1,563 +0,0 @@ -{ "module": - { "name": "List", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|0" }, - "info": - { "description": "List operations.

Some functions are flagged as not tail-recursive. A tail-recursive function uses constant stack space, while a non-tail-recursive function uses stack space proportional to the length of its list argument, which can be a problem with very long lists. When the function takes several list arguments, an approximate formula giving stack usage (in some unspecified constant unit) is shown in parentheses.

The above considerations can usually be ignored if your lists are not longer than about 10000 elements." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "List.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|1504" }, - "info": - { "description": "Return the length (number of elements) of the given list." }, - "type": "'a list -> int", - "params": [ - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.hd", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|1598" }, - "info": - { "description": "Return the first element of the given list. Raise Failure \"hd\" if the list is empty." }, - "type": "'a list -> 'a", - "params": [ - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.tl", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|1719" }, - "info": - { "description": "Return the given list without its first element. Raise Failure \"tl\" if the list is empty." }, - "type": "'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.nth", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|1850" }, - "info": - { "description": "Return the n-th element of the given list. The first element (head of the list) is at position 0. Raise Failure \"nth\" if the list is too short. Raise Invalid_argument \"List.nth\" if n is negative." }, - "type": "'a list -> int -> 'a", - "params": [ - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "List.rev", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|2102" }, - "info": - { "description": "List reversal." }, - "type": "'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.append", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|2154" }, - "info": - { "description": "Catenate two lists. Same function as the infix operator @. Not tail-recursive (length of the first argument). The @ operator is not tail-recursive either." }, - "type": "'a list -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.rev_append", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|2372" }, - "info": - { "description": "List.rev_append l1 l2 reverses l1 and concatenates it to l2. This is equivalent to List.rev l1 @ l2, but rev_append is tail-recursive and more efficient." }, - "type": "'a list -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.concat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|2600" }, - "info": - { "description": "Concatenate a list of lists. The elements of the argument are all concatenated together (in the same order) to give the result. Not tail-recursive (length of the argument + length of the longest sub-list)." }, - "type": "'a list list -> 'a list", - "params": [ - { "name": "", - "type": "'a list list" } ] } }, - { "value": - { "name": "List.flatten", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|2861" }, - "info": - { "description": "Same as concat. Not tail-recursive (length of the argument + length of the longest sub-list)." }, - "type": "'a list list -> 'a list", - "params": [ - { "name": "", - "type": "'a list list" } ] } }, - { "comment": "
Iterators
" }, - { "value": - { "name": "List.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|3031" }, - "info": - { "description": "List.iter f [a1; ...; an] applies function f in turn to a1; ...; an. It is equivalent to begin f a1; f a2; ...; f an; () end." }, - "type": "('a -> unit) -> 'a list -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|3222" }, - "info": - { "description": "List.map f [a1; ...; an] applies function f to a1, ..., an, and builds the list [f a1; ...; f an] with the results returned by f. Not tail-recursive." }, - "type": "('a -> 'b) -> 'a list -> 'b list", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.rev_map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|3440" }, - "info": - { "description": "List.rev_map f l gives the same result as List.rev (List.map f l), but is tail-recursive and more efficient." }, - "type": "('a -> 'b) -> 'a list -> 'b list", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.fold_left", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|3622" }, - "info": - { "description": "List.fold_left f a [b1; ...; bn] is f (... (f (f a b1) b2) ...) bn." }, - "type": "('a -> 'b -> 'a) -> 'a -> 'b list -> 'a", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'a" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.fold_right", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|3761" }, - "info": - { "description": "List.fold_right f [a1; ...; an] b is f a1 (f a2 (... (f an b) ...)). Not tail-recursive." }, - "type": "('a -> 'b -> 'b) -> 'a list -> 'b -> 'b", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'b" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a" } ] } }, - { "comment": "
Iterators on two lists
" }, - { "value": - { "name": "List.iter2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|3960" }, - "info": - { "description": "List.iter2 f [a1; ...; an] [b1; ...; bn] calls in turn f a1 b1; ...; f an bn. Raise Invalid_argument if the two lists have different lengths." }, - "type": "('a -> 'b -> unit) -> 'a list -> 'b list -> unit", - "params": [ - { "name": "", - "type": "'a -> 'b -> unit" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.map2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|4186" }, - "info": - { "description": "List.map2 f [a1; ...; an] [b1; ...; bn] is [f a1 b1; ...; f an bn]. Raise Invalid_argument if the two lists have different lengths. Not tail-recursive." }, - "type": "('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'c" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.rev_map2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|4423" }, - "info": - { "description": "List.rev_map2 f l1 l2 gives the same result as List.rev (List.map2 f l1 l2), but is tail-recursive and more efficient." }, - "type": "('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'c" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.fold_left2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|4633" }, - "info": - { "description": "List.fold_left2 f a [b1; ...; bn] [c1; ...; cn] is f (... (f (f a b1 c1) b2 c2) ...) bn cn. Raise Invalid_argument if the two lists have different lengths." }, - "type": "('a -> 'b -> 'c -> 'a) -> 'a -> 'b list -> 'c list -> 'a", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'c -> 'a" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.fold_right2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|4886" }, - "info": - { "description": "List.fold_right2 f [a1; ...; an] [b1; ...; bn] c is f a1 b1 (f a2 b2 (... (f an bn c) ...)). Raise Invalid_argument if the two lists have different lengths. Not tail-recursive." }, - "type": "('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'c", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'c -> 'c" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a" } ] } }, - { "comment": "
List scanning
" }, - { "value": - { "name": "List.for_all", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|5190" }, - "info": - { "description": "for_all p [a1; ...; an] checks if all elements of the list satisfy the predicate p. That is, it returns (p a1) && (p a2) && ... && (p an)." }, - "type": "('a -> bool) -> 'a list -> bool", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.exists", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|5395" }, - "info": - { "description": "exists p [a1; ...; an] checks if at least one element of the list satisfies the predicate p. That is, it returns (p a1) || (p a2) || ... || (p an)." }, - "type": "('a -> bool) -> 'a list -> bool", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.for_all2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|5608" }, - "info": - { "description": "Same as List.for_all, but for a two-argument predicate. Raise Invalid_argument if the two lists have different lengths." }, - "type": "('a -> 'b -> bool) -> 'a list -> 'b list -> bool", - "params": [ - { "name": "", - "type": "'a -> 'b -> bool" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.exists2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|5811" }, - "info": - { "description": "Same as List.exists, but for a two-argument predicate. Raise Invalid_argument if the two lists have different lengths." }, - "type": "('a -> 'b -> bool) -> 'a list -> 'b list -> bool", - "params": [ - { "name": "", - "type": "'a -> 'b -> bool" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.mem", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|6012" }, - "info": - { "description": "mem a l is true if and only if a is equal to an element of l." }, - "type": "'a -> 'a list -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.memq", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|6123" }, - "info": - { "description": "Same as List.mem, but uses physical equality instead of structural equality to compare list elements." }, - "type": "'a -> 'a list -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a list" } ] } }, - { "comment": "
List searching
" }, - { "value": - { "name": "List.find", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|6301" }, - "info": - { "description": "find p l returns the first element of the list l that satisfies the predicate p. Raise Not_found if there is no value that satisfies p in the list l." }, - "type": "('a -> bool) -> 'a list -> 'a", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.filter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|6521" }, - "info": - { "description": "filter p l returns all the elements of the list l that satisfy the predicate p. The order of the elements in the input list is preserved." }, - "type": "('a -> bool) -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.find_all", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|6729" }, - "info": - { "description": "find_all is another name for List.filter." }, - "type": "('a -> bool) -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.partition", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|6834" }, - "info": - { "description": "partition p l returns a pair of lists (l1, l2), where l1 is the list of all the elements of l that satisfy the predicate p, and l2 is the list of all the elements of l that do not satisfy p. The order of the elements in the input list is preserved." }, - "type": "('a -> bool) -> 'a list -> 'a list * 'a list", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a list" } ] } }, - { "comment": "
Association lists
" }, - { "value": - { "name": "List.assoc", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|7212" }, - "info": - { "description": "assoc a l returns the value associated with key a in the list of pairs l. That is, assoc a [ ...; (a,b); ...] = b if (a,b) is the leftmost binding of a in list l. Raise Not_found if there is no value associated with a in the list l." }, - "type": "'a -> ('a * 'b) list -> 'b", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "value": - { "name": "List.assq", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|7527" }, - "info": - { "description": "Same as List.assoc, but uses physical equality instead of structural equality to compare keys." }, - "type": "'a -> ('a * 'b) list -> 'b", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "value": - { "name": "List.mem_assoc", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|7674" }, - "info": - { "description": "Same as List.assoc, but simply return true if a binding exists, and false if no bindings exist for the given key." }, - "type": "'a -> ('a * 'b) list -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "value": - { "name": "List.mem_assq", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|7847" }, - "info": - { "description": "Same as List.mem_assoc, but uses physical equality instead of structural equality to compare keys." }, - "type": "'a -> ('a * 'b) list -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "value": - { "name": "List.remove_assoc", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|8004" }, - "info": - { "description": "remove_assoc a l returns the list of pairs l without the first pair with key a, if any. Not tail-recursive." }, - "type": "'a -> ('a * 'b) list -> ('a * 'b) list", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "value": - { "name": "List.remove_assq", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|8190" }, - "info": - { "description": "Same as List.remove_assoc, but uses physical equality instead of structural equality to compare keys. Not tail-recursive." }, - "type": "'a -> ('a * 'b) list -> ('a * 'b) list", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "comment": "
Lists of pairs
" }, - { "value": - { "name": "List.split", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|8413" }, - "info": - { "description": "Transform a list of pairs into a pair of lists: split [(a1,b1); ...; (an,bn)] is ([a1; ...; an], [b1; ...; bn]). Not tail-recursive." }, - "type": "('a * 'b) list -> 'a list * 'b list", - "params": [ - { "name": "", - "type": "('a * 'b) list" } ] } }, - { "value": - { "name": "List.combine", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|8612" }, - "info": - { "description": "Transform a pair of lists into a list of pairs: combine [a1; ...; an] [b1; ...; bn] is [(a1,b1); ...; (an,bn)]. Raise Invalid_argument if the two lists have different lengths. Not tail-recursive." }, - "type": "'a list -> 'b list -> ('a * 'b) list", - "params": [ - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "comment": "
Sorting
" }, - { "value": - { "name": "List.sort", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|8908" }, - "info": - { "description": "Sort a list in increasing order according to a comparison function. The comparison function must return 0 if its arguments compare as equal, a positive integer if the first is greater, and a negative integer if the first is smaller (see Array.sort for a complete specification). For example, Pervasives.compare is a suitable comparison function. The resulting list is sorted in increasing order. List.sort is guaranteed to run in constant heap space (in addition to the size of the result list) and logarithmic stack space.

The current implementation uses Merge Sort. It runs in constant heap space and logarithmic stack space." }, - "type": "('a -> 'a -> int) -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> 'a -> int" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.stable_sort", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|9636" }, - "info": - { "description": "Same as List.sort, but the sorting algorithm is guaranteed to be stable (i.e. elements that compare equal are kept in their original order) .

The current implementation uses Merge Sort. It runs in constant heap space and logarithmic stack space." }, - "type": "('a -> 'a -> int) -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> 'a -> int" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.fast_sort", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|9964" }, - "info": - { "description": "Same as List.sort or List.stable_sort, whichever is faster on typical input." }, - "type": "('a -> 'a -> int) -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> 'a -> int" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "List.merge", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/list.mli|10115" }, - "info": - { "description": "Merge two lists: Assuming that l1 and l2 are sorted according to the comparison function cmp, merge cmp l1 l2 will return a sorted list containting all the elements of l1 and l2. If several elements compare equal, the elements of l1 will be before the elements of l2. Not tail-recursive (sum of the lengths of the arguments)." }, - "type": "('a -> 'a -> int) -> 'a list -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> 'a -> int" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Log.json b/data/Log.json deleted file mode 100644 index 1ba1f68..0000000 --- a/data/Log.json +++ /dev/null @@ -1,160 +0,0 @@ -{ "module": - { "name": "Log", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|0" }, - "info": - { "description": "

Loggers

" }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Log.level", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|657" }, - "info": - { "description": "The level for log event" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "[ `debug | `error | `info | `warn ]" } }, - { "type": - { "name": "Log.logger", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|739" }, - "info": - { "description": "Logger arguments" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "date:string ->\n id:int ->\n level:Log.level ->\n section:string -> ?backtrace:string -> message:string -> unit" } }, - { "value": - { "name": "Log.add_logger", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|977" }, - "info": - { "description": "Add a named logger, which will be called on each new log event" }, - "type": "string -> Log.logger -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "Log.logger" } ] } }, - { "value": - { "name": "Log.rm_logger", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1049" }, - "info": - { "description": "Remove a named logger" }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Log.get_loggers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1115" }, - "info": - { "description": "Get all the active loggers" }, - "type": "unit -> string list", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Log.text_logger", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1211" }, - "info": - { "description": "Default logger : display all the result to stdout" }, - "type": "Log.logger", - "params": [ ] } }, - { "value": - { "name": "Log.text_logger_name", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1315" }, - "info": - { "description": "Name of the default text logger (usefull if one wants to uninstall it)" }, - "type": "string", - "params": [ ] } }, - { "comment": "

Log functions

" }, - { "value": - { "name": "Log.debug", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1372" }, - "info": "", - "type": "string -> ('a, unit, string, unit) Pervasives.format4 -> 'a", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "('a, unit, string, unit) Pervasives.format4" } ] } }, - { "value": - { "name": "Log.info", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1432" }, - "info": "", - "type": "string -> ('a, unit, string, unit) Pervasives.format4 -> 'a", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "('a, unit, string, unit) Pervasives.format4" } ] } }, - { "value": - { "name": "Log.warn", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1492" }, - "info": "", - "type": "string -> ('a, unit, string, unit) Pervasives.format4 -> 'a", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "('a, unit, string, unit) Pervasives.format4" } ] } }, - { "value": - { "name": "Log.error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1552" }, - "info": "", - "type": "string -> ('a, unit, string, unit) Pervasives.format4 -> 'a", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "('a, unit, string, unit) Pervasives.format4" } ] } }, - { "comment": "

Date functions

" }, - { "value": - { "name": "Log.set_date", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1695" }, - "info": - { "description": "Hook to get the date (OS modules might init it)" }, - "type": "(unit -> string) -> unit", - "params": [ - { "name": "", - "type": "unit -> string" } ] } }, - { "value": - { "name": "Log.set_id", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/log.mli|1779" }, - "info": - { "description": "Hook to get the current thread's id" }, - "type": "(unit -> int) -> unit", - "params": [ - { "name": "", - "type": "unit -> int" } ] } } ], - "dependencies": - { "uses": [ "*predef*" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt.json b/data/Lwt.json deleted file mode 100644 index 65fd30d..0000000 --- a/data/Lwt.json +++ /dev/null @@ -1,550 +0,0 @@ -{ "module": - { "name": "Lwt", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|0" }, - "info": - { "description": "Module Lwt: cooperative light-weight threads." }, - "type": "sig end", - "module_structure": [ - { "comment": "This module defines cooperative light-weight threads with their primitives. A light-weight thread represent a computation that may be not terminated, for example because it is waiting for some event to happen.

Lwt threads are cooperative in the sense that switching to another thread is awlays explicit (with Lwt.wakeup or wekup_exn). When a thread is running, it executes as much as possible, and then returns (a value or an eror) or sleeps.

Note that inside a Lwt thread, exceptions must be raised with Lwt.fail instead of raise. Also the try ... with ... construction will not catch Lwt errors. You must use Lwt.catch instead.

Lwt also provides the syntax extension Pa_lwt to make code using Lwt more readable." }, - { "comment": "
Definitions and basics
" }, - { "type": - { "name": "Lwt.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|1884" }, - "info": - { "description": "The type of threads returning a result of type 'a." }, - "params": [ - { "covariant": "true", - "contravariant": "false", - "type": "'a" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt.return", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|1953" }, - "info": - { "description": "return e is a thread whose return value is the value of the expression e." }, - "type": "'a -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt.fail", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|2071" }, - "info": - { "description": "fail e is a thread that fails with the exception e." }, - "type": "exn -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "exn" } ] } }, - { "value": - { "name": "Lwt.bind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|2160" }, - "info": - { "description": "bind t f is a thread which first waits for the thread t to terminate and then, if the thread succeeds, behaves as the application of function f to the return value of t. If the thread t fails, bind t f also fails, with the same exception.

The expression bind t (fun x -> t') can intuitively be read as let x = t in t', and if you use the lwt.syntax syntax extension, you can write a bind operation like that: lwt x = t in t'.

Note that bind is also often used just for synchronization purpose: t' will not execute before t is terminated.

The result of a thread can be bound several time." }, - "type": "'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t" }, - { "name": "", - "type": "'a -> 'b Lwt.t" } ] } }, - { "value": - { "name": "Lwt.(>>=)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|2890" }, - "info": - { "description": "t >>= f is an alternative notation for bind t f." }, - "type": "'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t" }, - { "name": "", - "type": "'a -> 'b Lwt.t" } ] } }, - { "value": - { "name": "Lwt.(=<<)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|2994" }, - "info": - { "description": "f =<< t is t >>= f" }, - "type": "('a -> 'b Lwt.t) -> 'a Lwt.t -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "value": - { "name": "Lwt.map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3068" }, - "info": - { "description": "map f m map the result of a thread. This is the same as bind m (fun x -> return (f x))" }, - "type": "('a -> 'b) -> 'a Lwt.t -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "value": - { "name": "Lwt.(>|=)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3212" }, - "info": - { "description": "m >|= f is map f m" }, - "type": "'a Lwt.t -> ('a -> 'b) -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t" }, - { "name": "", - "type": "'a -> 'b" } ] } }, - { "value": - { "name": "Lwt.(=|<)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3284" }, - "info": - { "description": "f =|< m is map f m" }, - "type": "('a -> 'b) -> 'a Lwt.t -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "comment": "
Thread storage
" }, - { "type": - { "name": "Lwt.key", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3387" }, - "info": - { "description": "Type of a key. Keys are used to store local values into threads" }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt.new_key", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3475" }, - "info": - { "description": "new_key () creates a new key." }, - "type": "unit -> 'a Lwt.key", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3546" }, - "info": - { "description": "get key returns the value associated with key in the current thread." }, - "type": "'a Lwt.key -> 'a option", - "params": [ - { "name": "", - "type": "'a Lwt.key" } ] } }, - { "value": - { "name": "Lwt.with_value", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3665" }, - "info": - { "description": "with_value key value f executes f with value associated to key. The previous value associated to key is restored after f terminates." }, - "type": "'a Lwt.key -> 'a option -> (unit -> 'b) -> 'b", - "params": [ - { "name": "", - "type": "'a Lwt.key" }, - { "name": "", - "type": "'a option" }, - { "name": "", - "type": "unit -> 'a" } ] } }, - { "comment": "
Exceptions handling
" }, - { "value": - { "name": "Lwt.catch", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|3923" }, - "info": - { "description": "catch t f is a thread that behaves as the thread t () if this thread succeeds. If the thread t () fails with some exception, catch t f behaves as the application of f to this exception." }, - "type": "(unit -> 'a Lwt.t) -> (exn -> 'a Lwt.t) -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "unit -> 'a Lwt.t" }, - { "name": "", - "type": "exn -> 'a Lwt.t" } ] } }, - { "value": - { "name": "Lwt.try_bind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|4200" }, - "info": - { "description": "try_bind t f g behaves as bind (t ()) f if t does not fail. Otherwise, it behaves as the application of g to the exception associated to t ()." }, - "type": "(unit -> 'a Lwt.t) -> ('a -> 'b Lwt.t) -> (exn -> 'b Lwt.t) -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "unit -> 'a Lwt.t" }, - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "exn -> 'a Lwt.t" } ] } }, - { "value": - { "name": "Lwt.finalize", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|4447" }, - "info": - { "description": "finalize f g returns the same result as f () whether it fails or not. In both cases, g () is executed after f." }, - "type": "(unit -> 'a Lwt.t) -> (unit -> unit Lwt.t) -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "unit -> 'a Lwt.t" }, - { "name": "", - "type": "unit -> unit Lwt.t" } ] } }, - { "comment": "
Multi-threads composition
" }, - { "value": - { "name": "Lwt.choose", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|4678" }, - "info": - { "description": "choose l behaves as the first thread in l to terminate. If several threads are already terminated, one is choosen at random.

Note: Lwt.choose leaves the local values of the current thread unchanged." }, - "type": "'a Lwt.t list -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t list" } ] } }, - { "value": - { "name": "Lwt.nchoose", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|4947" }, - "info": - { "description": "nchoose l returns the value of all that have succcessfully terminated. If all threads are sleeping, it waits for at least one to terminates. If one the threads of l fails, nchoose fails with the same exception.

Note: Lwt.nchoose leaves the local values of the current thread unchanged." }, - "type": "'a Lwt.t list -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t list" } ] } }, - { "value": - { "name": "Lwt.nchoose_split", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|5316" }, - "info": - { "description": "nchoose_split l does the same as Lwt.nchoose but also retrurns the list of threads that have not yet terminated." }, - "type": "'a Lwt.t list -> ('a list * 'a Lwt.t list) Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t list" } ] } }, - { "value": - { "name": "Lwt.join", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|5503" }, - "info": - { "description": "join l waits for all threads in l to terminate. If one of the threads fails, then join l will fails with the same exception as the first one to terminate.

Note: Lwt.join leaves the local values of the current thread unchanged." }, - "type": "unit Lwt.t list -> unit Lwt.t", - "params": [ - { "name": "", - "type": "unit Lwt.t list" } ] } }, - { "value": - { "name": "Lwt.()", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|5803" }, - "info": - { "description": "t <?> t' is the same as choose [t; t']" }, - "type": "'a Lwt.t -> 'a Lwt.t -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t" }, - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "value": - { "name": "Lwt.(<&>)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|5891" }, - "info": - { "description": "t <&> t' is the same as join [t; t']" }, - "type": "unit Lwt.t -> unit Lwt.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "unit Lwt.t" }, - { "name": "", - "type": "unit Lwt.t" } ] } }, - { "value": - { "name": "Lwt.ignore_result", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|5983" }, - "info": - { "description": "ignore_result t start the thread t and ignores its result value if the thread terminates sucessfully. However, if the thread t fails, the exception is raised instead of being ignored.

You should use this function if you want to start a thread and don't care what its return value is, nor when it terminates (for instance, because it is looping). Note that if the thread t yields and later fails, the exception will not be raised at this point in the program." }, - "type": "'a Lwt.t -> unit", - "params": [ - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "comment": "
Sleeping and resuming
" }, - { "type": - { "name": "Lwt.u", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|6582" }, - "info": - { "description": "The type of thread wakeners." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt.wait", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|6627" }, - "info": - { "description": "wait () is a pair of a thread which sleeps forever (unless it is resumed by one of the functions wakeup, wakeup_exn below) and the corresponding wakener. This thread does not block the execution of the remainder of the program (except of course, if another thread tries to wait for its termination)." }, - "type": "unit -> 'a Lwt.t * 'a Lwt.u", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt.wakeup", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|6999" }, - "info": - { "description": "wakeup t e makes the sleeping thread t terminate and return the value of the expression e." }, - "type": "'a Lwt.u -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a Lwt.u" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt.wakeup_exn", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|7144" }, - "info": - { "description": "wakeup_exn t e makes the sleeping thread t fail with the exception e." }, - "type": "'a Lwt.u -> exn -> unit", - "params": [ - { "name": "", - "type": "'a Lwt.u" }, - { "name": "", - "type": "exn" } ] } }, - { "value": - { "name": "Lwt.waiter_of_wakener", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|7273" }, - "info": - { "description": "Returns the thread associated to a wakener." }, - "type": "'a Lwt.u -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.u" } ] } }, - { "comment": "
Threads state
" }, - { "type": - { "name": "Lwt.state", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|7419" }, - "info": - { "description": "State of a thread" }, - "params": [ - { "covariant": "true", - "contravariant": "false", - "type": "'b" } ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Return", - "description": "The thread which has successfully terminated", - "type": [ "'a" ] }, - { "name": "Fail", - "description": "The thread raised an exception", - "type": [ "exn" ] }, - { "name": "Sleep", - "description": "The thread is sleeping", - "type": [ ] } ] } } }, - { "value": - { "name": "Lwt.state", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|7613" }, - "info": - { "description": "state t returns the state of a thread" }, - "type": "'a Lwt.t -> 'a Lwt.state", - "params": [ - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "comment": "
Cancelable threads
" }, - { "comment": "Cancelable threads are the same as regular threads except that they can be canceled." }, - { "exception": - { "name": "Lwt.Canceled", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|7820" }, - "info": - { "description": "Canceled threads fails with this exception" } } }, - { "value": - { "name": "Lwt.task", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|7892" }, - "info": - { "description": "task () is the same as wait () except that threads created with task can be canceled." }, - "type": "unit -> 'a Lwt.t * 'a Lwt.u", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt.on_cancel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|8031" }, - "info": - { "description": "on_cancel t f executes f when t is canceled. This is the same as catching Canceled." }, - "type": "'a Lwt.t -> (unit -> unit) -> unit", - "params": [ - { "name": "", - "type": "'a Lwt.t" }, - { "name": "", - "type": "unit -> unit" } ] } }, - { "value": - { "name": "Lwt.cancel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|8186" }, - "info": - { "description": "cancel t cancels the threads t. This means that the deepest sleeping thread created with task and connected to t is wakeup with the exception Lwt.Canceled.

For example, in the following code:

let waiter, wakener = task () in cancel (waiter >> printl \"plop\")

waiter will be waked up with Lwt.Canceled." }, - "type": "'a Lwt.t -> unit", - "params": [ - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "value": - { "name": "Lwt.pick", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|8594" }, - "info": - { "description": "pick l is the same as Lwt.choose, except that it cancels all sleeping threads when one terminates.

Note: Lwt.pick leaves the local values of the current thread unchanged." }, - "type": "'a Lwt.t list -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t list" } ] } }, - { "value": - { "name": "Lwt.npick", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|8823" }, - "info": - { "description": "npick l is the same as Lwt.nchoose, except that it cancels all sleeping threads when one terminates.

Note: Lwt.npick leaves the local values of the current thread unchanged." }, - "type": "'a Lwt.t list -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t list" } ] } }, - { "value": - { "name": "Lwt.protected", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|9061" }, - "info": - { "description": "protected thread creates a new cancelable thread which behave as thread except that cancelling it does not cancel thread." }, - "type": "'a Lwt.t -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt.t" } ] } }, - { "comment": "
Pause
" }, - { "value": - { "name": "Lwt.pause", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|9258" }, - "info": - { "description": "pause () is a sleeping thread which is wake up on the next call to Lwt.wakeup_paused. A thread created with pause can be canceled." }, - "type": "unit -> unit Lwt.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt.wakeup_paused", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|9441" }, - "info": - { "description": "wakeup_paused () wakes up all threads which suspended themselves with Lwt.pause.

This function is called by the scheduler, before entering the main loop. You usually do not have to call it directly, except if you are writing a custom scheduler.

Note that if a paused thread resume and pause again, it will not be wakeup at this point." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt.paused_count", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|9858" }, - "info": - { "description": "paused_count () returns the number of thread currently paused." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt.register_pause_notifier", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|9970" }, - "info": - { "description": "register_pause_notifier f register a function f that will be called each time pause is called. The parameter passed to f is the new number of threads paused. It is usefull to be able to call Lwt.wakeup_paused when there is no scheduler" }, - "type": "(int -> unit) -> unit", - "params": [ - { "name": "", - "type": "int -> unit" } ] } }, - { "comment": "
Misc
" }, - { "value": - { "name": "Lwt.on_success", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|10308" }, - "info": - { "description": "on_success t f executes f when t terminates without failing. This is the same as:

ignore_result (bind t (fun x -> f x; return ()))

but a bit more efficient." }, - "type": "'a Lwt.t -> ('a -> unit) -> unit", - "params": [ - { "name": "", - "type": "'a Lwt.t" }, - { "name": "", - "type": "'a -> unit" } ] } }, - { "value": - { "name": "Lwt.on_failure", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt.mli|10568" }, - "info": - { "description": "on_failure t f executes f when t terminates and fails. This is the same as:

ignore_result (catch t (fun e -> f e; return ()))

but a bit more efficient." }, - "type": "'a Lwt.t -> (exn -> unit) -> unit", - "params": [ - { "name": "", - "type": "'a Lwt.t" }, - { "name": "", - "type": "exn -> unit" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Lwt_util", "Lwt_stream", "Lwt_mvar", "Lwt_mutex", "Lwt_list", "Lwt_pool", "Lwt_condition", "Lwt_switch", "OS", "Net", "Block", "Dns", "Http" ] } } } \ No newline at end of file diff --git a/data/Lwt_condition.json b/data/Lwt_condition.json deleted file mode 100644 index c8c9953..0000000 --- a/data/Lwt_condition.json +++ /dev/null @@ -1,77 +0,0 @@ -{ "module": - { "name": "Lwt_condition", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_condition.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_condition.mli|0" }, - "info": - { "description": "Conditions" }, - "type": "sig end", - "module_structure": [ - { "comment": "Condition variables to synchronize between threads." }, - { "type": - { "name": "Lwt_condition.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_condition.mli|1771" }, - "info": - { "description": "Condition variable type. The type parameter denotes the type of value propagated from notifier to waiter." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'c" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt_condition.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_condition.mli|1903" }, - "info": - { "description": "create () creates a new condition variable." }, - "type": "unit -> 'a Lwt_condition.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt_condition.wait", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_condition.mli|1987" }, - "info": - { "description": "wait mutex condvar will cause the current thread to block, awaiting notification for a condition variable, condvar. If provided, the mutex must have been previously locked (within the scope of Lwt_mutex.with_lock, for example) and is temporarily unlocked until the condition is notified. Upon notification, mutex is re-locked before wait returns and the thread's activity is resumed. When the awaited condition is notified, the value parameter passed to notify is returned." }, - "type": "?mutex:Lwt_mutex.t -> 'a Lwt_condition.t -> 'a Lwt.t", - "params": [ - { "name": "mutex", - "type": "Lwt_mutex.t option" }, - { "name": "", - "type": "'a Lwt_condition.t" } ] } }, - { "value": - { "name": "Lwt_condition.signal", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_condition.mli|2601" }, - "info": - { "description": "signal condvar value notifies that a condition is ready. A single waiting thread will be awoken and will receive the notification value which will be returned from wait. Note that condition notification is not \"sticky\", i.e. if there is no waiter when notify is called, the notification will be missed and the value discarded." }, - "type": "'a Lwt_condition.t -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_condition.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt_condition.broadcast", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_condition.mli|3018" }, - "info": - { "description": "broadcast condvar value notifies all waiting threads. Each will be awoken in turn and will receive the same notification value." }, - "type": "'a Lwt_condition.t -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_condition.t" }, - { "name": "", - "type": "'a" } ] } } ], - "dependencies": - { "uses": [ "Lwt_mutex", "Lwt", "*predef*" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt_list.json b/data/Lwt_list.json deleted file mode 100644 index fcdddd3..0000000 --- a/data/Lwt_list.json +++ /dev/null @@ -1,225 +0,0 @@ -{ "module": - { "name": "Lwt_list", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|0" }, - "info": - { "description": "List helpers" }, - "type": "sig end", - "module_structure": [ - { "comment": "Note: this module use the same naming convention as Lwt_stream." }, - { "comment": "
List iterators
" }, - { "value": - { "name": "Lwt_list.iter_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1073" }, - "info": "", - "type": "('a -> unit Lwt.t) -> 'a list -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> unit Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.iter_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1130" }, - "info": "", - "type": "('a -> unit Lwt.t) -> 'a list -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> unit Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.map_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1188" }, - "info": "", - "type": "('a -> 'b Lwt.t) -> 'a list -> 'b list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.map_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1245" }, - "info": "", - "type": "('a -> 'b Lwt.t) -> 'a list -> 'b list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.rev_map_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1303" }, - "info": "", - "type": "('a -> 'b Lwt.t) -> 'a list -> 'b list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.rev_map_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1364" }, - "info": "", - "type": "('a -> 'b Lwt.t) -> 'a list -> 'b list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.fold_left_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1426" }, - "info": "", - "type": "('a -> 'b -> 'a Lwt.t) -> 'a -> 'b list -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'a Lwt.t" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.fold_right_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1497" }, - "info": "", - "type": "('a -> 'b -> 'b Lwt.t) -> 'a list -> 'b -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'b Lwt.t" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a" } ] } }, - { "comment": "
List scanning
" }, - { "value": - { "name": "Lwt_list.for_all_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1595" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> bool Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.for_all_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1655" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> bool Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.exists_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1716" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> bool Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.exists_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1775" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> bool Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "comment": "
List searching
" }, - { "value": - { "name": "Lwt_list.find_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1862" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.filter_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1918" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.filter_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|1980" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.partition_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|2043" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> ('a list * 'a list) Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_list.partition_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_list.mli|2120" }, - "info": "", - "type": "('a -> bool Lwt.t) -> 'a list -> ('a list * 'a list) Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a list" } ] } } ], - "dependencies": - { "uses": [ "Lwt" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt_mutex.json b/data/Lwt_mutex.json deleted file mode 100644 index 203d666..0000000 --- a/data/Lwt_mutex.json +++ /dev/null @@ -1,91 +0,0 @@ -{ "module": - { "name": "Lwt_mutex", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|0" }, - "info": - { "description": "Cooperative locks for mutual exclusion" }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Lwt_mutex.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|1054" }, - "info": - { "description": "Type of Lwt mutexes" }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt_mutex.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|1086" }, - "info": - { "description": "create () creates a new mutex, which is initially unlocked" }, - "type": "unit -> Lwt_mutex.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt_mutex.lock", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|1180" }, - "info": - { "description": "lock mutex lockcs the mutex, that is:

Note: threads are wake up is the same order they try to lock the mutex" }, - "type": "Lwt_mutex.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Lwt_mutex.t" } ] } }, - { "value": - { "name": "Lwt_mutex.unlock", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|1607" }, - "info": - { "description": "unlock mutex unlock the mutex if no threads is waiting on it. Otherwise it removes the first one and resumes it." }, - "type": "Lwt_mutex.t -> unit", - "params": [ - { "name": "", - "type": "Lwt_mutex.t" } ] } }, - { "value": - { "name": "Lwt_mutex.is_locked", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|1761" }, - "info": - { "description": "locked mutex returns whether mutex is currently locked" }, - "type": "Lwt_mutex.t -> bool", - "params": [ - { "name": "", - "type": "Lwt_mutex.t" } ] } }, - { "value": - { "name": "Lwt_mutex.is_empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|1856" }, - "info": - { "description": "is_empty mutex returns true if they are no thread waiting on the mutex, and false otherwise" }, - "type": "Lwt_mutex.t -> bool", - "params": [ - { "name": "", - "type": "Lwt_mutex.t" } ] } }, - { "value": - { "name": "Lwt_mutex.with_lock", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mutex.mli|1995" }, - "info": - { "description": "with_lock lock f is used to lock a mutex within a block scope. The function f () is called with the mutex locked, and its result is returned from the call to
_lock
. If an exception is raised from f, the mutex is also unlocked before the scope of
_lock
is exited." }, - "type": "Lwt_mutex.t -> (unit -> 'a Lwt.t) -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "Lwt_mutex.t" }, - { "name": "", - "type": "unit -> 'a Lwt.t" } ] } } ], - "dependencies": - { "uses": [ "Lwt" ], - "used_by": [ "Lwt_condition" ] } } } \ No newline at end of file diff --git a/data/Lwt_mvar.json b/data/Lwt_mvar.json deleted file mode 100644 index dcdc97b..0000000 --- a/data/Lwt_mvar.json +++ /dev/null @@ -1,73 +0,0 @@ -{ "module": - { "name": "Lwt_mvar", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mvar.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mvar.mli|0" }, - "info": - { "description": "Mailbox variables" }, - "type": "sig end", - "module_structure": [ - { "comment": "\"Mailbox\" variables implement a synchronising variable, used for communication between concurrent threads.

This code adapted from Comparing lightweight threads (eigenclass.org)" }, - { "type": - { "name": "Lwt_mvar.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mvar.mli|2032" }, - "info": - { "description": "The type of a mailbox variable. Mailbox variables are used to communicate values between threads in a synchronous way. The type parameter specifies the type of the value propagated from put to take." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt_mvar.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mvar.mli|2269" }, - "info": - { "description": "create v creates a new mailbox variable containing value v." }, - "type": "'a -> 'a Lwt_mvar.t", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt_mvar.create_empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mvar.mli|2367" }, - "info": - { "description": "create () creates a new empty mailbox variable." }, - "type": "unit -> 'a Lwt_mvar.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt_mvar.put", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mvar.mli|2459" }, - "info": - { "description": "put mvar value puts a value into a mailbox variable. This value will remain in the mailbox until take is called to remove it. If the mailbox is not empty, the current thread will block until it is emptied." }, - "type": "'a Lwt_mvar.t -> 'a -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_mvar.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt_mvar.take", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_mvar.mli|2732" }, - "info": - { "description": "take mvar will take any currently available value from the mailbox variable. If no value is currently available, the current thread will block, awaiting a value to be put by another thread." }, - "type": "'a Lwt_mvar.t -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_mvar.t" } ] } } ], - "dependencies": - { "uses": [ "Lwt" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt_pool.json b/data/Lwt_pool.json deleted file mode 100644 index b7acd7d..0000000 --- a/data/Lwt_pool.json +++ /dev/null @@ -1,55 +0,0 @@ -{ "module": - { "name": "Lwt_pool", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pool.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pool.mli|0" }, - "info": - { "description": "Creating pools (for example pools of connections to a database)." }, - "type": "sig end", - "module_structure": [ - { "comment": "Instead of creating a new connection each time you need one, keep a pool of opened connections and reuse opened connections that are free." }, - { "type": - { "name": "Lwt_pool.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pool.mli|1179" }, - "info": - { "description": "Type of pools" }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt_pool.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pool.mli|1311" }, - "info": - { "description": "create n f creates a new pool with at most n members. f is the function to use to create a new pool member." }, - "type": "int ->\n ?check:('a -> (bool -> unit) -> unit) -> (unit -> 'a Lwt.t) -> 'a Lwt_pool.t", - "params": [ - { "name": "", - "type": "int" }, - { "name": "check", - "type": "('a -> (bool -> unit) -> unit) option" }, - { "name": "", - "type": "unit -> 'a Lwt.t" } ] } }, - { "value": - { "name": "Lwt_pool.use", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pool.mli|1496" }, - "info": - { "description": "use p f takes one free member of the pool p and gives it to the function f." }, - "type": "'a Lwt_pool.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_pool.t" }, - { "name": "", - "type": "'a -> 'b Lwt.t" } ] } } ], - "dependencies": - { "uses": [ "Lwt", "*predef*" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt_pqueue.json b/data/Lwt_pqueue.json deleted file mode 100644 index e68f336..0000000 --- a/data/Lwt_pqueue.json +++ /dev/null @@ -1,44 +0,0 @@ -{ "module": - { "name": "Lwt_pqueue", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "module_type": - { "name": "Lwt_pqueue.OrderedType", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli|1003" }, - "info": "", - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Lwt_pqueue.S", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli|1084" }, - "info": "", - "type": "sig end", - "kind": "" } }, - { "module": - { "name": "Lwt_pqueue.Make", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_pqueue.mli|1349" }, - "info": "", - "type": "functor (Ord : OrderedType) -> sig end", - "module_functor": - { "parameter": - { "name": "Ord" }, - "module_with": "unavailable" }, - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt_sequence.json b/data/Lwt_sequence.json deleted file mode 100644 index 0f74ccf..0000000 --- a/data/Lwt_sequence.json +++ /dev/null @@ -1,303 +0,0 @@ -{ "module": - { "name": "Lwt_sequence", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|0" }, - "info": - { "description": "Mutable sequence of elements" }, - "type": "sig end", - "module_structure": [ - { "comment": "A sequence is an object holding a list of elements which support the following operations:

" }, - { "type": - { "name": "Lwt_sequence.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|1389" }, - "info": - { "description": "Type of a sequence holding values of type 'a" }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" } ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "Lwt_sequence.node", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|1456" }, - "info": - { "description": "Type of a node holding one value of type 'a in a sequence" }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "comment": "
Operation on nodes
" }, - { "value": - { "name": "Lwt_sequence.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|1566" }, - "info": - { "description": "Returns the contents of a node" }, - "type": "'a Lwt_sequence.node -> 'a", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.node" } ] } }, - { "value": - { "name": "Lwt_sequence.set", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|1631" }, - "info": - { "description": "Change the contents of a node" }, - "type": "'a Lwt_sequence.node -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.node" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt_sequence.remove", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|1703" }, - "info": - { "description": "Removes a node from the sequence it is part of. It does nothing if the node has already been removed." }, - "type": "'a Lwt_sequence.node -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.node" } ] } }, - { "comment": "
Operations on sequence
" }, - { "value": - { "name": "Lwt_sequence.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|1885" }, - "info": - { "description": "create () creates a new empty sequence" }, - "type": "unit -> 'a Lwt_sequence.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt_sequence.is_empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|1962" }, - "info": - { "description": "Returns true iff the given sequence is empty" }, - "type": "'a Lwt_sequence.t -> bool", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2047" }, - "info": - { "description": "Returns the number of elemenets in the given sequence. This is a O(n) operation where n is the number of elements in the sequence." }, - "type": "'a Lwt_sequence.t -> int", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.add_l", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2227" }, - "info": - { "description": "add_l x s adds x to the left of the sequence s" }, - "type": "'a -> 'a Lwt_sequence.t -> 'a Lwt_sequence.node", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.add_r", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2324" }, - "info": - { "description": "add_l x s adds x to the right of the sequence s" }, - "type": "'a -> 'a Lwt_sequence.t -> 'a Lwt_sequence.node", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "exception": - { "name": "Lwt_sequence.Empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2422" }, - "info": - { "description": "Exception raised by take_l and tale_s and when the sequence is empty" } } }, - { "value": - { "name": "Lwt_sequence.take_l", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2527" }, - "info": - { "description": "take_l x s remove and returns the leftmost element of s", - "raised_exceptions": [ - { "raised_exception": "Empty", - "text": "if the sequence is empty" } ] }, - "type": "'a Lwt_sequence.t -> 'a", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.take_r", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2666" }, - "info": - { "description": "take_l x s remove and returns the rightmost element of s", - "raised_exceptions": [ - { "raised_exception": "Empty", - "text": "if the sequence is empty" } ] }, - "type": "'a Lwt_sequence.t -> 'a", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.take_opt_l", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2806" }, - "info": - { "description": "take_opt_l x s remove and returns Some x where x is the leftmost element of s or None if s is empty" }, - "type": "'a Lwt_sequence.t -> 'a option", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.take_opt_r", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|2969" }, - "info": - { "description": "take_opt_l x s remove and returns Some x where x is the rightmost element of s or None if s is empty" }, - "type": "'a Lwt_sequence.t -> 'a option", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.transfer_l", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|3133" }, - "info": - { "description": "transfer_l s1 s2 removes all elements of s1 and add them at the left of s2. This operation runs in constant time and space." }, - "type": "'a Lwt_sequence.t -> 'a Lwt_sequence.t -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.transfer_r", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|3323" }, - "info": - { "description": "transfer_r s1 s2 removes all elements of s1 and add them at the right of s2. This operation runs in constant time and space." }, - "type": "'a Lwt_sequence.t -> 'a Lwt_sequence.t -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.t" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "comment": "
Sequence iterators
" }, - { "comment": "Note: it is OK to remove a node while traversing a sequence" }, - { "value": - { "name": "Lwt_sequence.iter_l", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|3613" }, - "info": - { "description": "iter_l f s applies f on all elements of s starting from the left" }, - "type": "('a -> unit) -> 'a Lwt_sequence.t -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.iter_r", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|3742" }, - "info": - { "description": "iter_l f s applies f on all elements of s starting from the right" }, - "type": "('a -> unit) -> 'a Lwt_sequence.t -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.iter_node_l", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|3872" }, - "info": - { "description": "iter_l f s applies f on all nodes of s starting from the left" }, - "type": "('a Lwt_sequence.node -> unit) -> 'a Lwt_sequence.t -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.node -> unit" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.iter_node_r", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|4008" }, - "info": - { "description": "iter_l f s applies f on all nodes of s starting from the right" }, - "type": "('a Lwt_sequence.node -> unit) -> 'a Lwt_sequence.t -> unit", - "params": [ - { "name": "", - "type": "'a Lwt_sequence.node -> unit" }, - { "name": "", - "type": "'a Lwt_sequence.t" } ] } }, - { "value": - { "name": "Lwt_sequence.fold_l", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|4145" }, - "info": - { "description": "fold_l f s is: fold_l f s x = f en (... (f e2 (f e1 x))) where e1, e2, ..., en are the elements of s" }, - "type": "('a -> 'b -> 'b) -> 'a Lwt_sequence.t -> 'b -> 'b", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'b" }, - { "name": "", - "type": "'a Lwt_sequence.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt_sequence.fold_r", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_sequence.mli|4350" }, - "info": - { "description": "fold_r f s is: fold_r f s x = f e1 (f e2 (... (f en x))) where e1, e2, ..., en are the elements of s" }, - "type": "('a -> 'b -> 'b) -> 'a Lwt_sequence.t -> 'b -> 'b", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'b" }, - { "name": "", - "type": "'a Lwt_sequence.t" }, - { "name": "", - "type": "'a" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt_stream.json b/data/Lwt_stream.json deleted file mode 100644 index 03ef81c..0000000 --- a/data/Lwt_stream.json +++ /dev/null @@ -1,618 +0,0 @@ -{ "module": - { "name": "Lwt_stream", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|0" }, - "info": - { "description": "Data streams" }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Lwt_stream.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|970" }, - "info": - { "description": "Type of a stream holding values of type 'a" }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "comment": "Naming convention: in this module all function taking a function which is applied to all element of the streams are suffixed by:

" }, - { "comment": "
Construction
" }, - { "value": - { "name": "Lwt_stream.from", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|1342" }, - "info": - { "description": "from f creates an stream from the given input function. f is called each time more input is needed, and the stream ends when f returns None." }, - "type": "(unit -> 'a option Lwt.t) -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "unit -> 'a option Lwt.t" } ] } }, - { "value": - { "name": "Lwt_stream.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|1558" }, - "info": - { "description": "create () returns a new stream and a push function" }, - "type": "unit -> 'a Lwt_stream.t * ('a option -> unit)", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt_stream.of_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|1669" }, - "info": - { "description": "of_list l creates a stream returning all elements of l" }, - "type": "'a list -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_stream.of_array", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|1768" }, - "info": - { "description": "of_array a creates a stream returning all elements of a" }, - "type": "'a array -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Lwt_stream.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|1870" }, - "info": - { "description": "of_string str creates a stream returning all characters of str" }, - "type": "string -> char Lwt_stream.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Lwt_stream.clone", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|1986" }, - "info": - { "description": "clone st clone the given stream. Operations on each stream will not affect the other.

For example:

# let st1 = Lwt_stream.of_list [1; 2; 3];; val st1 : int Lwt_stream.t = <abstr> # let st2 = Lwt_stream.clone st1;; val st2 : int Lwt_stream.t = <abstr> # lwt x = Lwt_stream.next st1;; val x : int = 1 # lwt y = Lwt_stream.next st2;; val y : int = 1 " }, - "type": "'a Lwt_stream.t -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "comment": "
Destruction
" }, - { "value": - { "name": "Lwt_stream.to_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|2492" }, - "info": - { "description": "Returns the list of elements of the given stream" }, - "type": "'a Lwt_stream.t -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|2587" }, - "info": - { "description": "Returns the word composed of all characters of the given stream" }, - "type": "char Lwt_stream.t -> string Lwt.t", - "params": [ - { "name": "", - "type": "char Lwt_stream.t" } ] } }, - { "comment": "
Data retreival
" }, - { "exception": - { "name": "Lwt_stream.Empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|2733" }, - "info": - { "description": "Exception raised when trying to retreive data from an empty stream." } } }, - { "value": - { "name": "Lwt_stream.peek", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|2833" }, - "info": - { "description": "peek st returns the first element of the stream, if any, without removing it." }, - "type": "'a Lwt_stream.t -> 'a option Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.npeek", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|2964" }, - "info": - { "description": "npeek n st returns at most the first n elements of st, without removing them." }, - "type": "int -> 'a Lwt_stream.t -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|3105" }, - "info": - { "description": "get st remove and returns the first element of the stream, if any." }, - "type": "'a Lwt_stream.t -> 'a option Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.nget", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|3224" }, - "info": - { "description": "nget n st remove and returns at most the first n elements of st." }, - "type": "int -> 'a Lwt_stream.t -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.get_while", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|3351" }, - "info": "", - "type": "('a -> bool) -> 'a Lwt_stream.t -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.get_while_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|3405" }, - "info": - { "description": "get_while f st returns the longest prefix of st where all elements satisfy f." }, - "type": "('a -> bool Lwt.t) -> 'a Lwt_stream.t -> 'a list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.next", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|3567" }, - "info": - { "description": "next st remove and returns the next element of the stream, of fail with Lwt_stream.Empty if the stream is empty." }, - "type": "'a Lwt_stream.t -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.last_new", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|3718" }, - "info": - { "description": "next_new st if no element are available on st without sleeping, then it is the same as next st. Otherwise it removes all elements of st that are ready except the last one, and return it.

If fails with Lwt_stream.Empty if the stream has no more elements" }, - "type": "'a Lwt_stream.t -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.junk", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4038" }, - "info": - { "description": "junk st remove the first element of st." }, - "type": "'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.njunk", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4122" }, - "info": - { "description": "njunk n st removes at most the first n elements of the stream." }, - "type": "int -> 'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.junk_while", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4243" }, - "info": "", - "type": "('a -> bool) -> 'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.junk_while_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4295" }, - "info": - { "description": "junk_while f st removes all elements at the beginning of the streams which satisfy f." }, - "type": "('a -> bool Lwt.t) -> 'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.junk_old", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4461" }, - "info": - { "description": "junk_old st removes all elements that are ready to be read without yeilding from st.

For example the read_password function of Lwt_read_line use that to junk key previously typed by the user." }, - "type": "'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.get_available", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4726" }, - "info": - { "description": "get_available l returns all available elements of l without blocking" }, - "type": "'a Lwt_stream.t -> 'a list", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.get_available_up_to", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4851" }, - "info": - { "description": "get_available_up_to l n returns up to n elements of l without blocking" }, - "type": "int -> 'a Lwt_stream.t -> 'a list", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.is_empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|4993" }, - "info": - { "description": "is_empty enum returns wether the given stream is empty" }, - "type": "'a Lwt_stream.t -> bool Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "comment": "
Stream transversal
" }, - { "comment": "Note: all the following functions are destructive.

For example:

# let st1 = Lwt_stream.of_list [1; 2; 3];; val st1 : int Lwt_stream.t = <abstr> # let st2 = Lwt_stream.map string_of_int st1;; val st2 : string Lwt_stream.t = <abstr> # lwt x = Lwt_stream.next st1;; val x : int = 1 # lwt y = Lwt_stream.next st2;; val y : string = \"2\" " }, - { "value": - { "name": "Lwt_stream.choose", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|5533" }, - "info": - { "description": "choose l creates an stream from a list of streams. The resulting stream will returns elements returned by any stream of l in an unspecified order." }, - "type": "'a Lwt_stream.t list -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t list" } ] } }, - { "value": - { "name": "Lwt_stream.map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|5737" }, - "info": "", - "type": "('a -> 'b) -> 'a Lwt_stream.t -> 'b Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.map_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|5774" }, - "info": - { "description": "map f st maps the value returned by st with f" }, - "type": "('a -> 'b Lwt.t) -> 'a Lwt_stream.t -> 'b Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.filter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|5881" }, - "info": "", - "type": "('a -> bool) -> 'a Lwt_stream.t -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.filter_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|5923" }, - "info": - { "description": "filter f st keeps only value x such that f x is true" }, - "type": "('a -> bool Lwt.t) -> 'a Lwt_stream.t -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.filter_map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6044" }, - "info": "", - "type": "('a -> 'b option) -> 'a Lwt_stream.t -> 'b Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> 'b option" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.filter_map_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6095" }, - "info": - { "description": "filter_map f st filter and map st at the same time" }, - "type": "('a -> 'b option Lwt.t) -> 'a Lwt_stream.t -> 'b Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> 'b option Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.map_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6219" }, - "info": "", - "type": "('a -> 'b list) -> 'a Lwt_stream.t -> 'b Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> 'b list" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.map_list_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6266" }, - "info": - { "description": "map_list f st applies f on each element of st and flattens the lists returned" }, - "type": "('a -> 'b list Lwt.t) -> 'a Lwt_stream.t -> 'b Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a -> 'b list Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.fold", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6421" }, - "info": "", - "type": "('a -> 'b -> 'b) -> 'a Lwt_stream.t -> 'b -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'b" }, - { "name": "", - "type": "'a Lwt_stream.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt_stream.fold_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6475" }, - "info": - { "description": "fold f s x fold_like function for streams." }, - "type": "('a -> 'b -> 'b Lwt.t) -> 'a Lwt_stream.t -> 'b -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'b Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Lwt_stream.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6592" }, - "info": "", - "type": "('a -> unit) -> 'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.iter_p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6638" }, - "info": "", - "type": "('a -> unit Lwt.t) -> 'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> unit Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.iter_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6692" }, - "info": - { "description": "iter f s iterates over all elements of the stream" }, - "type": "('a -> unit Lwt.t) -> 'a Lwt_stream.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> unit Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.find", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6808" }, - "info": "", - "type": "('a -> bool) -> 'a Lwt_stream.t -> 'a option Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.find_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6859" }, - "info": - { "description": "find f s find an element in a stream." }, - "type": "('a -> bool Lwt.t) -> 'a Lwt_stream.t -> 'a option Lwt.t", - "params": [ - { "name": "", - "type": "'a -> bool Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.find_map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|6968" }, - "info": "", - "type": "('a -> 'b option) -> 'a Lwt_stream.t -> 'b option Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b option" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.find_map_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|7028" }, - "info": - { "description": "find f s find and map at the same time." }, - "type": "('a -> 'b option Lwt.t) -> 'a Lwt_stream.t -> 'b option Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b option Lwt.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.combine", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|7148" }, - "info": - { "description": "combine s1 s2 combine two streams. The stream will ends when the first stream ends." }, - "type": "'a Lwt_stream.t -> 'b Lwt_stream.t -> ('a * 'b) Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.append", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|7292" }, - "info": - { "description": "append s1 s2 returns a stream which returns all elements of s1, then all elements of s2" }, - "type": "'a Lwt_stream.t -> 'a Lwt_stream.t -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" }, - { "name": "", - "type": "'a Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.concat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|7436" }, - "info": - { "description": "concat st returns the concatenation of all streams of st." }, - "type": "'a Lwt_stream.t Lwt_stream.t -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t Lwt_stream.t" } ] } }, - { "value": - { "name": "Lwt_stream.flatten", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|7536" }, - "info": - { "description": "flatten st = map_list (fun l -> l) st" }, - "type": "'a list Lwt_stream.t -> 'a Lwt_stream.t", - "params": [ - { "name": "", - "type": "'a list Lwt_stream.t" } ] } }, - { "comment": "
Parsing
" }, - { "value": - { "name": "Lwt_stream.parse", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|7638" }, - "info": - { "description": "parse st f parses st with f. If f raise an exception, st is restored to its previous state." }, - "type": "'a Lwt_stream.t -> ('a Lwt_stream.t -> 'b Lwt.t) -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a Lwt_stream.t" }, - { "name": "", - "type": "'a Lwt_stream.t -> 'b Lwt.t" } ] } }, - { "comment": "
Misc
" }, - { "value": - { "name": "Lwt_stream.hexdump", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_stream.mli|7824" }, - "info": - { "description": "hexdump byte_stream returns a stream which is the same as the output of hexdump -C.

Basically, here is a simple implementation of hexdump -C:

open Lwt open Lwt_io let () = Lwt_main.run (write_lines stdout (Lwt_stream.hexdump (read_lines stdin))) " }, - "type": "char Lwt_stream.t -> string Lwt_stream.t", - "params": [ - { "name": "", - "type": "char Lwt_stream.t" } ] } } ], - "dependencies": - { "uses": [ "Lwt" ], - "used_by": [ "Net", "Block", "Http" ] } } } \ No newline at end of file diff --git a/data/Lwt_switch.json b/data/Lwt_switch.json deleted file mode 100644 index 2d76ca6..0000000 --- a/data/Lwt_switch.json +++ /dev/null @@ -1,101 +0,0 @@ -{ "module": - { "name": "Lwt_switch", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|0" }, - "info": - { "description": "Lwt switches" }, - "type": "sig end", - "module_structure": [ - { "comment": "Switch have two goals:

For example, considers the following interface:

type id val free : id -> unit Lwt.t val f : unit -> id Lwt.t val g : unit -> id Lwt.t val h : unit -> id Lwt.t

Now you want to calls f, g and h in parallel. You can simply do:

lwt idf = f () and idg = g () and idh = h () in ...

However, one may wants to handle possible failures of f (), g () and h (), and disable all allocated resources if one of these three threads fails. This may be hard since you have to remember which one failed and which one returned correctly.

Now we change a little bit the interface:

val f : ?switch : Lwt_switch.t -> unit -> id Lwt.t val g : ?switch : Lwt_switch.t -> unit -> id Lwt.t val h : ?switch : Lwt_switch.t -> unit -> id Lwt.t

and the code becomes:

let switch = Lwt_switch.create () in try_lwt lwt idf = f ~switch () and idg = g ~switch () and idh = h ~switch () in ... with exn -> lwt () = Lwt_switch.turn_off switch in raise_lwt exn " }, - { "type": - { "name": "Lwt_switch.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|2306" }, - "info": - { "description": "Type of switches." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt_switch.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|2336" }, - "info": - { "description": "create () creates a new switch." }, - "type": "unit -> Lwt_switch.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Lwt_switch.is_on", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|2403" }, - "info": - { "description": "is_on switch returns true if the switch is currently on, and false otherwise." }, - "type": "Lwt_switch.t -> bool", - "params": [ - { "name": "", - "type": "Lwt_switch.t" } ] } }, - { "value": - { "name": "Lwt_switch.turn_off", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|2525" }, - "info": - { "description": "turn_off switch turns off the switch. It calls all registered hooks, waits for all of them to terminates, and the returns. If one of the hook failed, then it will fail with one of the exception raised by hooks. If the switch is already off, then it does nothing." }, - "type": "Lwt_switch.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Lwt_switch.t" } ] } }, - { "exception": - { "name": "Lwt_switch.Off", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|2855" }, - "info": - { "description": "Exception raised when trying to add a hook to a switch that is already off." } } }, - { "value": - { "name": "Lwt_switch.check", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|2961" }, - "info": - { "description": "check switch does nothing if switch is None or contains an switch that is currently on, and raise Lwt_switch.Off otherwise." }, - "type": "Lwt_switch.t option -> unit", - "params": [ - { "name": "", - "type": "Lwt_switch.t option" } ] } }, - { "value": - { "name": "Lwt_switch.add_hook", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|3128" }, - "info": - { "description": "add_hook switch f registers f so it will be called when Lwt_switch.turn_off is invoked. It does nothing if switch is None. If switch contains an switch that is already off then Lwt_switch.Off is raised." }, - "type": "Lwt_switch.t option -> (unit -> unit Lwt.t) -> unit", - "params": [ - { "name": "", - "type": "Lwt_switch.t option" }, - { "name": "", - "type": "unit -> unit Lwt.t" } ] } }, - { "value": - { "name": "Lwt_switch.add_hook_or_exec", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_switch.mli|3409" }, - "info": - { "description": "add_hook_or_exec switch f is the same as Lwt_switch.add_hook except that if the switch is already off, then f is called immediatly." }, - "type": "Lwt_switch.t option -> (unit -> unit Lwt.t) -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Lwt_switch.t option" }, - { "name": "", - "type": "unit -> unit Lwt.t" } ] } } ], - "dependencies": - { "uses": [ "Lwt" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Lwt_util.json b/data/Lwt_util.json deleted file mode 100644 index b8775f4..0000000 --- a/data/Lwt_util.json +++ /dev/null @@ -1,145 +0,0 @@ -{ "module": - { "name": "Lwt_util", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|0" }, - "info": - { "description": "Note: This lodule is deprecated. Use Lwt_list and Lwt_pool instead." }, - "type": "sig end", - "module_structure": [ - { "comment": "

Lists iterators

" }, - { "value": - { "name": "Lwt_util.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|1115" }, - "info": - { "description": "iter f l start a thread for each element in l. The threads are started according to the list order, but then can run concurrently. It terminates when all the threads are terminated, if all threads are successful. It fails if any of the threads fail." }, - "type": "('a -> unit Lwt.t) -> 'a list -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> unit Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_util.iter_serial", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|1471" }, - "info": - { "description": "Similar to iter but wait for one thread to terminate before starting the next one." }, - "type": "('a -> unit Lwt.t) -> 'a list -> unit Lwt.t", - "params": [ - { "name": "", - "type": "'a -> unit Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_util.map", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|1638" }, - "info": - { "description": "map f l apply f to each element in l and collect the results of the threads thus created. The threads are started according to the list order, but then can run concurrently. map f l fails if any of the threads fail." }, - "type": "('a -> 'b Lwt.t) -> 'a list -> 'b list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_util.map_with_waiting_action", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|1954" }, - "info": - { "description": "map_with_waiting_action f wa l apply f to each element in l and collect the results of the threads thus created. The threads are started according to the list order, but then can run concurrently. The difference with map f l is that function wa will be called on the element that the function is waiting for its termination." }, - "type": "('a -> 'b Lwt.t) -> ('a -> unit) -> 'a list -> 'b list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_util.map_serial", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|2455" }, - "info": - { "description": "Similar to map but wait for one thread to terminate before starting the next one." }, - "type": "('a -> 'b Lwt.t) -> 'a list -> 'b list Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Lwt.t" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Lwt_util.fold_left", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|2621" }, - "info": - { "description": "Similar to List.fold_left." }, - "type": "('a -> 'b -> 'a Lwt.t) -> 'a -> 'b list -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'a Lwt.t" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a list" } ] } }, - { "comment": "

Regions

" }, - { "type": - { "name": "Lwt_util.region", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|2763" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Lwt_util.make_region", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|2771" }, - "info": - { "description": "make_region sz create a region of size sz." }, - "type": "int -> Lwt_util.region", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Lwt_util.resize_region", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|2863" }, - "info": - { "description": "resize_region reg sz resize the region reg to size sz." }, - "type": "Lwt_util.region -> int -> unit", - "params": [ - { "name": "", - "type": "Lwt_util.region" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Lwt_util.run_in_region", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/lwt_util.mli|2979" }, - "info": - { "description": "run_in_region reg size f execute the thread produced by the function f in the region reg. The thread is not started before some room is available in the region." }, - "type": "Lwt_util.region -> int -> (unit -> 'a Lwt.t) -> 'a Lwt.t", - "params": [ - { "name": "", - "type": "Lwt_util.region" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "unit -> 'a Lwt.t" } ] } } ], - "dependencies": - { "uses": [ "Lwt" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Map.json b/data/Map.json deleted file mode 100644 index 48163b3..0000000 --- a/data/Map.json +++ /dev/null @@ -1,48 +0,0 @@ -{ "module": - { "name": "Map", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli|0" }, - "info": - { "description": "Association tables over ordered types.

This module implements applicative association tables, also known as finite maps or dictionaries, given a total ordering function over the keys. All operations over maps are purely applicative (no side-effects). The implementation uses balanced binary trees, and therefore searching and insertion take time logarithmic in the size of the map." }, - "type": "sig end", - "module_structure": [ - { "module_type": - { "name": "Map.OrderedType", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli|1356" }, - "info": - { "description": "Input signature of the functor Map.Make." }, - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Map.S", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli|1976" }, - "info": - { "description": "Output signature of the functor Map.Make." }, - "type": "sig end", - "kind": "" } }, - { "module": - { "name": "Map.Make", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/map.mli|7523" }, - "info": - { "description": "Functor building an implementation of the map structure given a totally ordered type." }, - "type": "functor (Ord : OrderedType) -> sig end", - "module_functor": - { "parameter": - { "name": "Ord" }, - "module_with": "unavailable" }, - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Marshal.json b/data/Marshal.json deleted file mode 100644 index 09bf5e2..0000000 --- a/data/Marshal.json +++ /dev/null @@ -1,111 +0,0 @@ -{ "module": - { "name": "Marshal", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|0" }, - "info": - { "description": "Marshaling of data structures.

This module provides functions to encode arbitrary data structures as sequences of bytes, which can then be written on a file or sent over a pipe or network connection. The bytes can then be read back later, possibly in another process, and decoded back into a data structure. The format for the byte sequences is compatible across all machines for a given version of Objective Caml.

Warning: marshaling is currently not type-safe. The type of marshaled data is not transmitted along the value of the data, making it impossible to check that the data read back possesses the type expected by the context. In particular, the result type of the Marshal.from_* functions is given as 'a, but this is misleading: the returned Caml value does not possess type 'a for all 'a; it has one, unique type which cannot be determined at compile-type. The programmer should explicitly give the expected type of the returned value, using the following syntax: The representation of marshaled values is not human-readable, and uses bytes that are not printable characters. Therefore, input and output channels used in conjunction with Marshal.to_channel and Marshal.from_channel must be opened in binary mode, using e.g. open_out_bin or open_in_bin; channels opened in text mode will cause unmarshaling errors on platforms where text channels behave differently than binary channels, e.g. Windows." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Marshal.extern_flags", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|2603" }, - "info": - { "description": "The flags to the Marshal.to_* functions below." }, - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "No_sharing", - "description": "Don't preserve sharing", - "type": [ ] }, - { "name": "Closures", - "description": "Send function closures", - "type": [ ] } ] } } }, - { "value": - { "name": "Marshal.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|2815" }, - "info": - { "description": "Marshal.to_string v flags returns a string containing the representation of v as a sequence of bytes. The flags argument has the same meaning as for Marshal.to_channel." }, - "type": "'a -> Marshal.extern_flags list -> string", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "Marshal.extern_flags list" } ] } }, - { "value": - { "name": "Marshal.to_buffer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|3099" }, - "info": - { "description": "Marshal.to_buffer buff ofs len v flags marshals the value v, storing its byte representation in the string buff, starting at character number ofs, and writing at most len characters. It returns the number of characters actually written to the string. If the byte representation of v does not fit in len characters, the exception Failure is raised." }, - "type": "string -> int -> int -> 'a -> Marshal.extern_flags list -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "Marshal.extern_flags list" } ] } }, - { "value": - { "name": "Marshal.from_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|3561" }, - "info": - { "description": "Marshal.from_string buff ofs unmarshals a structured value like Marshal.from_channel does, except that the byte representation is not read from a channel, but taken from the string buff, starting at position ofs." }, - "type": "string -> int -> 'a", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Marshal.header_size", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|3838" }, - "info": - { "description": "The bytes representing a marshaled value are composed of a fixed-size header and a variable-sized data part, whose size can be determined from the header. Marshal.header_size is the size, in characters, of the header. Marshal.data_size buff ofs is the size, in characters, of the data part, assuming a valid header is stored in buff starting at position ofs. Finally, Marshal.total_size buff ofs is the total size, in characters, of the marshaled value. Both Marshal.data_size and Marshal.total_size raise Failure if buff, ofs does not contain a valid header.

To read the byte representation of a marshaled value into a string buffer, the program needs to read first Marshal.header_size characters into the buffer, then determine the length of the remainder of the representation using Marshal.data_size, make sure the buffer is large enough to hold the remaining data, then read it, and finally call Marshal.from_string to unmarshal the value." }, - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Marshal.data_size", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|4906" }, - "info": - { "description": "See Marshal.header_size." }, - "type": "string -> int -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Marshal.total_size", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/marshal.mli|4978" }, - "info": - { "description": "See Marshal.header_size." }, - "type": "string -> int -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Nativeint.json b/data/Nativeint.json deleted file mode 100644 index 8cbc2cf..0000000 --- a/data/Nativeint.json +++ /dev/null @@ -1,377 +0,0 @@ -{ "module": - { "name": "Nativeint", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|0" }, - "info": - { "description": "Processor-native integers.

This module provides operations on the type nativeint of signed 32-bit integers (on 32-bit platforms) or signed 64-bit integers (on 64-bit platforms). This integer type has exactly the same width as that of a long integer type in the C compiler. All arithmetic operations over nativeint are taken modulo 232 or 264 depending on the word size of the architecture.

Performance notice: values of type nativeint occupy more memory space than values of type int, and arithmetic operations on nativeint are generally slower than those on int. Use nativeint only when the application requires the extra bit of precision over the int type." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Nativeint.zero", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|1682" }, - "info": - { "description": "The native integer 0." }, - "type": "nativeint", - "params": [ ] } }, - { "value": - { "name": "Nativeint.one", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|1732" }, - "info": - { "description": "The native integer 1." }, - "type": "nativeint", - "params": [ ] } }, - { "value": - { "name": "Nativeint.minus_one", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|1781" }, - "info": - { "description": "The native integer -1." }, - "type": "nativeint", - "params": [ ] } }, - { "value": - { "name": "Nativeint.neg", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|1837" }, - "info": - { "description": "Unary negation." }, - "type": "nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.add", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|1918" }, - "info": - { "description": "Addition." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.sub", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|2006" }, - "info": - { "description": "Subtraction." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.mul", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|2097" }, - "info": - { "description": "Multiplication." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.div", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|2191" }, - "info": - { "description": "Integer division. Raise Division_by_zero if the second argument is zero. This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/)." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.rem", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|2458" }, - "info": - { "description": "Integer remainder. If y is not zero, the result of Nativeint.rem x y satisfies the following properties: Nativeint.zero <= Nativeint.rem x y < Nativeint.abs y and x = Nativeint.add (Nativeint.mul (Nativeint.div x y) y) (Nativeint.rem x y). If y = 0, Nativeint.rem x y raises Division_by_zero." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.succ", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|2856" }, - "info": - { "description": "Successor. Nativeint.succ x is Nativeint.add x Nativeint.one." }, - "type": "nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.pred", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|2967" }, - "info": - { "description": "Predecessor. Nativeint.pred x is Nativeint.sub x Nativeint.one." }, - "type": "nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.abs", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3080" }, - "info": - { "description": "Return the absolute value of its argument." }, - "type": "nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.size", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3164" }, - "info": - { "description": "The size in bits of a native integer. This is equal to 32 on a 32-bit platform and to 64 on a 64-bit platform." }, - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Nativeint.max_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3306" }, - "info": - { "description": "The greatest representable native integer, either 231 - 1 on a 32-bit platform, or 263 - 1 on a 64-bit platform." }, - "type": "nativeint", - "params": [ ] } }, - { "value": - { "name": "Nativeint.min_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3463" }, - "info": - { "description": "The greatest representable native integer, either -231 on a 32-bit platform, or -263 on a 64-bit platform." }, - "type": "nativeint", - "params": [ ] } }, - { "value": - { "name": "Nativeint.logand", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3614" }, - "info": - { "description": "Bitwise logical and." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.logor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3716" }, - "info": - { "description": "Bitwise logical or." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.logxor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3815" }, - "info": - { "description": "Bitwise logical exclusive or." }, - "type": "nativeint -> nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.lognot", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3926" }, - "info": - { "description": "Bitwise logical negation" }, - "type": "nativeint -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.shift_left", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|3995" }, - "info": - { "description": "Nativeint.shift_left x y shifts x to the left by y bits. The result is unspecified if y < 0 or y >= bitsize, where bitsize is 32 on a 32-bit platform and 64 on a 64-bit platform." }, - "type": "nativeint -> int -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Nativeint.shift_right", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|4278" }, - "info": - { "description": "Nativeint.shift_right x y shifts x to the right by y bits. This is an arithmetic shift: the sign bit of x is replicated and inserted in the vacated bits. The result is unspecified if y < 0 or y >= bitsize." }, - "type": "nativeint -> int -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Nativeint.shift_right_logical", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|4585" }, - "info": - { "description": "Nativeint.shift_right_logical x y shifts x to the right by y bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of x. The result is unspecified if y < 0 or y >= bitsize." }, - "type": "nativeint -> int -> nativeint", - "params": [ - { "name": "", - "type": "nativeint" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Nativeint.of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|4913" }, - "info": - { "description": "Convert the given integer (type int) to a native integer (type nativeint)." }, - "type": "int -> nativeint", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Nativeint.to_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|5060" }, - "info": - { "description": "Convert the given native integer (type nativeint) to an integer (type int). The high-order bit is lost during the conversion." }, - "type": "nativeint -> int", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|5262" }, - "info": - { "description": "Convert the given floating-point number to a native integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [Nativeint.min_int, Nativeint.max_int]." }, - "type": "float -> nativeint", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Nativeint.to_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|5607" }, - "info": - { "description": "Convert the given native integer to a floating-point number." }, - "type": "nativeint -> float", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.of_int32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|5743" }, - "info": - { "description": "Convert the given 32-bit integer (type int32) to a native integer." }, - "type": "int32 -> nativeint", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Nativeint.to_int32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|5886" }, - "info": - { "description": "Convert the given native integer to a 32-bit integer (type int32). On 64-bit platforms, the 64-bit native integer is taken modulo 232, i.e. the top 32 bits are lost. On 32-bit platforms, the conversion is exact." }, - "type": "nativeint -> int32", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "value": - { "name": "Nativeint.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|6188" }, - "info": - { "description": "Convert the given string to a native integer. The string is read in decimal (by default) or in hexadecimal, octal or binary if the string begins with 0x, 0o or 0b respectively. Raise Failure \"int_of_string\" if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integers representable in type nativeint." }, - "type": "string -> nativeint", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Nativeint.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|6659" }, - "info": - { "description": "Return the string representation of its argument, in decimal." }, - "type": "nativeint -> string", - "params": [ - { "name": "", - "type": "nativeint" } ] } }, - { "type": - { "name": "Nativeint.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|6770" }, - "info": - { "description": "An alias for the type of native integers." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "nativeint" } }, - { "value": - { "name": "Nativeint.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/nativeint.mli|6834" }, - "info": - { "description": "The comparison function for native integers, with the same specification as Pervasives.compare. Along with the type t, this function compare allows the module Nativeint to be passed as argument to the functors Set.Make and Map.Make." }, - "type": "Nativeint.t -> Nativeint.t -> int", - "params": [ - { "name": "", - "type": "Nativeint.t" }, - { "name": "", - "type": "Nativeint.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Random" ] } } } \ No newline at end of file diff --git a/data/Net.json b/data/Net.json deleted file mode 100644 index 8d74128..0000000 --- a/data/Net.json +++ /dev/null @@ -1,1101 +0,0 @@ -{ "module": - { "name": "Net", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Net.Nettypes", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Net.Nettypes.bytes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|29" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string" } }, - { "type": - { "name": "Net.Nettypes.ethernet_mac", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|50" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Net.Nettypes.ethernet_mac_of_bytes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|63" }, - "info": "", - "type": "string -> Net.Nettypes.ethernet_mac", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Net.Nettypes.ethernet_mac_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|114" }, - "info": "", - "type": "string -> Net.Nettypes.ethernet_mac option", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Net.Nettypes.ethernet_mac_to_bytes", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|173" }, - "info": "", - "type": "Net.Nettypes.ethernet_mac -> Net.Nettypes.bytes", - "params": [ - { "name": "", - "type": "Net.Nettypes.ethernet_mac" } ] } }, - { "value": - { "name": "Net.Nettypes.ethernet_mac_to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|223" }, - "info": "", - "type": "Net.Nettypes.ethernet_mac -> string", - "params": [ - { "name": "", - "type": "Net.Nettypes.ethernet_mac" } ] } }, - { "value": - { "name": "Net.Nettypes.ethernet_mac_broadcast", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|275" }, - "info": "", - "type": "Net.Nettypes.ethernet_mac", - "params": [ ] } }, - { "type": - { "name": "Net.Nettypes.ipv4_addr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|322" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Net.Nettypes.ipv4_addr_of_tuple", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|332" }, - "info": "", - "type": "int32 * int32 * int32 * int32 -> Net.Nettypes.ipv4_addr", - "params": [ - { "tuple": - { "type": "int32 * int32 * int32 * int32", - "contents": [ - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" }, - { "name": "", - "type": "int32" } ] } } ] } }, - { "value": - { "name": "Net.Nettypes.ipv4_addr_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|402" }, - "info": "", - "type": "string -> Net.Nettypes.ipv4_addr option", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Net.Nettypes.ipv4_addr_to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|455" }, - "info": "", - "type": "Net.Nettypes.ipv4_addr -> string", - "params": [ - { "name": "", - "type": "Net.Nettypes.ipv4_addr" } ] } }, - { "value": - { "name": "Net.Nettypes.ipv4_addr_of_uint32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|501" }, - "info": "", - "type": "int32 -> Net.Nettypes.ipv4_addr", - "params": [ - { "name": "", - "type": "int32" } ] } }, - { "value": - { "name": "Net.Nettypes.ipv4_addr_to_uint32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|546" }, - "info": "", - "type": "Net.Nettypes.ipv4_addr -> int32", - "params": [ - { "name": "", - "type": "Net.Nettypes.ipv4_addr" } ] } }, - { "value": - { "name": "Net.Nettypes.ipv4_blank", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|591" }, - "info": "", - "type": "Net.Nettypes.ipv4_addr", - "params": [ ] } }, - { "value": - { "name": "Net.Nettypes.ipv4_broadcast", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|618" }, - "info": "", - "type": "Net.Nettypes.ipv4_addr", - "params": [ ] } }, - { "value": - { "name": "Net.Nettypes.ipv4_localhost", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|649" }, - "info": "", - "type": "Net.Nettypes.ipv4_addr", - "params": [ ] } }, - { "type": - { "name": "Net.Nettypes.ipv4_src", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|686" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Net.Nettypes.ipv4_addr option * int" } }, - { "type": - { "name": "Net.Nettypes.ipv4_dst", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|725" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Net.Nettypes.ipv4_addr * int" } }, - { "type": - { "name": "Net.Nettypes.arp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|758" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "op", - "mutable": false, - "type": "[ `Reply | `Request | `Unknown of int ]" }, - { "name": "sha", - "mutable": false, - "type": "Net.Nettypes.ethernet_mac" }, - { "name": "spa", - "mutable": false, - "type": "Net.Nettypes.ipv4_addr" }, - { "name": "tha", - "mutable": false, - "type": "Net.Nettypes.ethernet_mac" }, - { "name": "tpa", - "mutable": false, - "type": "Net.Nettypes.ipv4_addr" } ] } } }, - { "type": - { "name": "Net.Nettypes.peer_uid", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|897" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int" } }, - { "exception": - { "name": "Net.Nettypes.Closed", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|913" }, - "info": "" } }, - { "module_type": - { "name": "Net.Nettypes.FLOW", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|931" }, - "info": "", - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Net.Nettypes.DATAGRAM", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|1318" }, - "info": "", - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Net.Nettypes.CHANNEL", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|1522" }, - "info": "", - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Net.Nettypes.RPC", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2233" }, - "info": "", - "type": "sig end", - "kind": "" } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Net.Manager", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2490" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "exception": - { "name": "Net.Manager.Error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2513" }, - "info": "", - "exception_args": [ "string" ] } }, - { "module": - { "name": "Net.Manager.Unix", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2539" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Net.Manager.Unix.ipv4", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2568" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int32" } }, - { "type": - { "name": "Net.Manager.Unix.port", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2590" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int" } }, - { "type": - { "name": "Net.Manager.Unix.uid", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2610" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int" } }, - { "type": - { "name": "Net.Manager.Unix.fd", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2628" }, - "info": "", - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" } ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "Net.Manager.Unix.resp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2643" }, - "info": "", - "params": [ - { "covariant": "true", - "contravariant": "false", - "type": "'b" } ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "OK", - "type": [ "'a" ] }, - { "name": "Err", - "type": [ "string" ] }, - { "name": "Retry", - "type": [ ] } ] } } }, - { "value": - { "name": "Net.Manager.Unix.tcpv4_connect", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2691" }, - "info": "", - "type": "Net.Manager.Unix.ipv4 ->\n Net.Manager.Unix.port -> [ `tcpv4 ] Net.Manager.Unix.fd Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "Net.Manager.Unix.ipv4" }, - { "name": "", - "type": "Net.Manager.Unix.port" } ] } }, - { "value": - { "name": "Net.Manager.Unix.tcpv4_bind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2778" }, - "info": "", - "type": "Net.Manager.Unix.ipv4 ->\n Net.Manager.Unix.port -> [ `tcpv4 ] Net.Manager.Unix.fd Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "Net.Manager.Unix.ipv4" }, - { "name": "", - "type": "Net.Manager.Unix.port" } ] } }, - { "value": - { "name": "Net.Manager.Unix.tcpv4_listen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2859" }, - "info": "", - "type": "[ `tcpv4 ] Net.Manager.Unix.fd -> unit Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `tcpv4 ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.tcpv4_accept", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|2937" }, - "info": "", - "type": "[ `tcpv4 ] Net.Manager.Unix.fd ->\n ([ `tcpv4 ] Net.Manager.Unix.fd * Net.Manager.Unix.ipv4 *\n Net.Manager.Unix.port)\n Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `tcpv4 ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.udpv4_socket", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3039" }, - "info": "", - "type": "unit -> [ `udpv4 ] Net.Manager.Unix.fd", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Net.Manager.Unix.udpv4_bind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3111" }, - "info": "", - "type": "Net.Manager.Unix.ipv4 ->\n Net.Manager.Unix.port -> [ `udpv4 ] Net.Manager.Unix.fd Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "Net.Manager.Unix.ipv4" }, - { "name": "", - "type": "Net.Manager.Unix.port" } ] } }, - { "value": - { "name": "Net.Manager.Unix.udpv4_recvfrom", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3192" }, - "info": "", - "type": "[ `udpv4 ] Net.Manager.Unix.fd ->\n string ->\n int ->\n int ->\n (Net.Manager.Unix.ipv4 * Net.Manager.Unix.port * int) Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `udpv4 ] Net.Manager.Unix.fd" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Net.Manager.Unix.udpv4_sendto", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3312" }, - "info": "", - "type": "[ `udpv4 ] Net.Manager.Unix.fd ->\n string ->\n int ->\n int ->\n Net.Manager.Unix.ipv4 * Net.Manager.Unix.port -> int Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `udpv4 ] Net.Manager.Unix.fd" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "tuple": - { "type": "Net.Manager.Unix.ipv4 * Net.Manager.Unix.port", - "contents": [ - { "name": "", - "type": "Net.Manager.Unix.ipv4" }, - { "name": "", - "type": "Net.Manager.Unix.port" } ] } } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_uid", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3427" }, - "info": "", - "type": "unit -> Net.Manager.Unix.uid", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_bind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3486" }, - "info": "", - "type": "Net.Manager.Unix.uid -> [ `domain ] Net.Manager.Unix.fd Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "Net.Manager.Unix.uid" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_connect", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3561" }, - "info": "", - "type": "Net.Manager.Unix.uid -> [ `domain ] Net.Manager.Unix.fd Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "Net.Manager.Unix.uid" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_accept", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3642" }, - "info": "", - "type": "[ `domain ] Net.Manager.Unix.fd ->\n [ `domain ] Net.Manager.Unix.fd Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `domain ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3732" }, - "info": "", - "type": "unit -> Net.Manager.Unix.uid list", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_read", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3797" }, - "info": "", - "type": "[ `domain ] Net.Manager.Unix.fd -> string Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `domain ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_write", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3875" }, - "info": "", - "type": "[ `domain ] Net.Manager.Unix.fd -> string -> unit Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `domain ] Net.Manager.Unix.fd" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_send_pipe", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|3963" }, - "info": "", - "type": "[ `domain ] Net.Manager.Unix.fd ->\n [< `rd_pipe | `wr_pipe ] Net.Manager.Unix.fd -> unit Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `domain ] Net.Manager.Unix.fd" }, - { "name": "", - "type": "[< `rd_pipe | `wr_pipe ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.domain_recv_pipe", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4078" }, - "info": "", - "type": "[ `domain ] Net.Manager.Unix.fd ->\n [< `rd_pipe | `wr_pipe ] Net.Manager.Unix.fd Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[ `domain ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.pipe", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4185" }, - "info": "", - "type": "unit ->\n ([ `rd_pipe ] Net.Manager.Unix.fd * [ `wr_pipe ] Net.Manager.Unix.fd)\n Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Net.Manager.Unix.connect_result", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4274" }, - "info": "", - "type": "[< `domain | `tcpv4 ] Net.Manager.Unix.fd -> unit Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[< `domain | `tcpv4 ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.read", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4373" }, - "info": "", - "type": "[< `rd_pipe | `tcpv4 | `udpv4 ] Net.Manager.Unix.fd ->\n string -> int -> int -> int Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[< `rd_pipe | `tcpv4 | `udpv4 ] Net.Manager.Unix.fd" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Net.Manager.Unix.write", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4485" }, - "info": "", - "type": "[< `tcpv4 | `udpv4 | `wr_pipe ] Net.Manager.Unix.fd ->\n string -> int -> int -> int Net.Manager.Unix.resp", - "params": [ - { "name": "", - "type": "[< `tcpv4 | `udpv4 | `wr_pipe ] Net.Manager.Unix.fd" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Net.Manager.Unix.close", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4599" }, - "info": "", - "type": "[< `domain | `rd_pipe | `tcpv4 | `udpv4 | `wr_pipe ] Net.Manager.Unix.fd ->\n unit", - "params": [ - { "name": "", - "type": "[< `domain | `rd_pipe | `tcpv4 | `udpv4 | `wr_pipe ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.fd_to_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4706" }, - "info": "", - "type": "'a Net.Manager.Unix.fd -> int", - "params": [ - { "name": "", - "type": "'a Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.fdbind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4758" }, - "info": "", - "type": "(int -> 'a Lwt.t) ->\n ('b Net.Manager.Unix.fd -> 'c Net.Manager.Unix.resp) ->\n 'b Net.Manager.Unix.fd -> 'c Lwt.t", - "params": [ - { "name": "", - "type": "int -> 'a Lwt.t" }, - { "name": "", - "type": "'a Net.Manager.Unix.fd -> 'b Net.Manager.Unix.resp" }, - { "name": "", - "type": "'a Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.Unix.iobind", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4836" }, - "info": "", - "type": "('a -> 'b Net.Manager.Unix.resp) -> 'a -> 'b Lwt.t", - "params": [ - { "name": "", - "type": "'a -> 'b Net.Manager.Unix.resp" }, - { "name": "", - "type": "'a" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "type": - { "name": "Net.Manager.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4895" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Net.Manager.local_peers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4897" }, - "info": "", - "type": "'a -> Net.Manager.Unix.uid list", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Net.Manager.local_uid", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4935" }, - "info": "", - "type": "'a -> Net.Manager.Unix.uid", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Net.Manager.connect_to_peer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|4966" }, - "info": "", - "type": "Net.Manager.t ->\n Net.Nettypes.peer_uid -> [ `domain ] Net.Manager.Unix.fd option Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "name": "", - "type": "Net.Nettypes.peer_uid" } ] } }, - { "value": - { "name": "Net.Manager.listen_to_peers", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5047" }, - "info": "", - "type": "Net.Manager.t ->\n (int ->\n [< `rd_pipe | `wr_pipe ] Net.Manager.Unix.fd *\n [< `rd_pipe | `wr_pipe ] Net.Manager.Unix.fd -> unit Lwt.t) ->\n unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "name": "", - "type": "int ->\n [< `rd_pipe | `wr_pipe ] Net.Manager.Unix.fd *\n [< `rd_pipe | `wr_pipe ] Net.Manager.Unix.fd -> unit Lwt.t" } ] } }, - { "value": - { "name": "Net.Manager.connect", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5179" }, - "info": "", - "type": "Net.Manager.t ->\n Net.Nettypes.peer_uid ->\n ([ `rd_pipe ] Net.Manager.Unix.fd * [ `wr_pipe ] Net.Manager.Unix.fd ->\n 'a Lwt.t) ->\n 'a Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "name": "", - "type": "Net.Nettypes.peer_uid" }, - { "name": "", - "type": "[ `rd_pipe ] Net.Manager.Unix.fd * [ `wr_pipe ] Net.Manager.Unix.fd ->\n 'a Lwt.t" } ] } }, - { "value": - { "name": "Net.Manager.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5289" }, - "info": "", - "type": "unit -> (Net.Manager.t * 'a Lwt.t) Lwt.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Net.Manager.get_udpv4", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5331" }, - "info": "", - "type": "Net.Manager.t -> [ `udpv4 ] Net.Manager.Unix.fd", - "params": [ - { "name": "", - "type": "Net.Manager.t" } ] } }, - { "value": - { "name": "Net.Manager.register_udpv4_listener", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5371" }, - "info": "", - "type": "Net.Manager.t ->\n Net.Nettypes.ipv4_addr option * int -> [ `udpv4 ] Net.Manager.Unix.fd -> unit", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "tuple": - { "type": "Net.Nettypes.ipv4_addr option * int", - "contents": [ - { "name": "", - "type": "Net.Nettypes.ipv4_addr option" }, - { "name": "", - "type": "int" } ] } }, - { "name": "", - "type": "[ `udpv4 ] Net.Manager.Unix.fd" } ] } }, - { "value": - { "name": "Net.Manager.get_udpv4_listener", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5468" }, - "info": "", - "type": "Net.Manager.t ->\n Net.Nettypes.ipv4_addr option * Net.Manager.Unix.port ->\n [ `udpv4 ] Net.Manager.Unix.fd Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "tuple": - { "type": "Net.Nettypes.ipv4_addr option * Net.Manager.Unix.port", - "contents": [ - { "name": "", - "type": "Net.Nettypes.ipv4_addr option" }, - { "name": "", - "type": "Net.Manager.Unix.port" } ] } } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Net.Flow", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5568" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Net.Flow.TCPv4", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5603" }, - "info": "", - "type": "sig end", - "module_with": "unavailable", - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Net.Flow.Pipe", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5708" }, - "info": "", - "type": "sig end", - "module_with": "unavailable", - "dependencies": - { "uses": [ ] } } }, - { "type": - { "name": "Net.Flow.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5817" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Net.Flow.read", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5819" }, - "info": "", - "type": "Net.Flow.t -> Bitstring.t option Lwt.t", - "params": [ - { "name": "", - "type": "Net.Flow.t" } ] } }, - { "value": - { "name": "Net.Flow.write", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5859" }, - "info": "", - "type": "Net.Flow.t -> Bitstring.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Flow.t" }, - { "name": "", - "type": "Bitstring.t" } ] } }, - { "value": - { "name": "Net.Flow.close", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5901" }, - "info": "", - "type": "Net.Flow.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Flow.t" } ] } }, - { "value": - { "name": "Net.Flow.connect", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|5929" }, - "info": "", - "type": "Net.Manager.t ->\n [> `Pipe of\n Net.Nettypes.peer_uid option * Net.Nettypes.peer_uid *\n (Net.Flow.t -> 'a Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src option * Net.Nettypes.ipv4_dst *\n (Net.Flow.t -> 'a Lwt.t) ] ->\n 'a Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "name": "", - "type": "[> `Pipe of\n Net.Nettypes.peer_uid option * Net.Nettypes.peer_uid *\n (Net.Flow.t -> 'a Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src option * Net.Nettypes.ipv4_dst *\n (Net.Flow.t -> 'a Lwt.t) ]" } ] } }, - { "value": - { "name": "Net.Flow.listen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6098" }, - "info": "", - "type": "Net.Manager.t ->\n [> `Pipe of\n Net.Nettypes.peer_uid *\n (Net.Nettypes.peer_uid -> Net.Flow.t -> unit Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src *\n (Net.Nettypes.ipv4_dst -> Net.Flow.t -> unit Lwt.t) ] ->\n unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "name": "", - "type": "[> `Pipe of\n Net.Nettypes.peer_uid *\n (Net.Nettypes.peer_uid -> Net.Flow.t -> unit Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src *\n (Net.Nettypes.ipv4_dst -> Net.Flow.t -> unit Lwt.t) ]" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Net.Datagram", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6264" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Net.Datagram.UDPv4", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6288" }, - "info": "", - "type": "sig end", - "module_with": "unavailable", - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Net.Channel", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6457" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Net.Channel.TCPv4", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6495" }, - "info": "", - "type": "sig end", - "module_with": "unavailable", - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "Net.Channel.Pipe", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6603" }, - "info": "", - "type": "sig end", - "module_with": "unavailable", - "dependencies": - { "uses": [ ] } } }, - { "type": - { "name": "Net.Channel.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6715" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Net.Channel.read_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6718" }, - "info": "", - "type": "Net.Channel.t -> char Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" } ] } }, - { "value": - { "name": "Net.Channel.read_some", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6749" }, - "info": "", - "type": "?len:int -> Net.Channel.t -> Bitstring.t Lwt.t", - "params": [ - { "name": "len", - "type": "int option" }, - { "name": "", - "type": "Net.Channel.t" } ] } }, - { "value": - { "name": "Net.Channel.read_until", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6799" }, - "info": "", - "type": "Net.Channel.t -> char -> (bool * Bitstring.t) Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Net.Channel.read_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6855" }, - "info": "", - "type": "?len:int -> Net.Channel.t -> Bitstring.t Lwt_stream.t", - "params": [ - { "name": "len", - "type": "int option" }, - { "name": "", - "type": "Net.Channel.t" } ] } }, - { "value": - { "name": "Net.Channel.read_crlf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6914" }, - "info": "", - "type": "Net.Channel.t -> Bitstring.t Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" } ] } }, - { "value": - { "name": "Net.Channel.write_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6953" }, - "info": "", - "type": "Net.Channel.t -> char -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Net.Channel.write_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|6994" }, - "info": "", - "type": "Net.Channel.t -> string -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Net.Channel.write_bitstring", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|7039" }, - "info": "", - "type": "Net.Channel.t -> Bitstring.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" }, - { "name": "", - "type": "Bitstring.t" } ] } }, - { "value": - { "name": "Net.Channel.write_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|7092" }, - "info": "", - "type": "Net.Channel.t -> string -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Net.Channel.flush", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|7136" }, - "info": "", - "type": "Net.Channel.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" } ] } }, - { "value": - { "name": "Net.Channel.close", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|7164" }, - "info": "", - "type": "Net.Channel.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Channel.t" } ] } }, - { "value": - { "name": "Net.Channel.connect", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|7193" }, - "info": "", - "type": "Net.Manager.t ->\n [> `Pipe of\n Net.Nettypes.peer_uid option * Net.Nettypes.peer_uid *\n (Net.Channel.t -> 'a Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src option * Net.Nettypes.ipv4_dst *\n (Net.Channel.t -> 'a Lwt.t) ] ->\n 'a Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "name": "", - "type": "[> `Pipe of\n Net.Nettypes.peer_uid option * Net.Nettypes.peer_uid *\n (Net.Channel.t -> 'a Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src option * Net.Nettypes.ipv4_dst *\n (Net.Channel.t -> 'a Lwt.t) ]" } ] } }, - { "value": - { "name": "Net.Channel.listen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/net.mli|7362" }, - "info": "", - "type": "Net.Manager.t ->\n [> `Pipe of\n Net.Nettypes.peer_uid *\n (Net.Nettypes.peer_uid -> Net.Channel.t -> unit Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src *\n (Net.Nettypes.ipv4_dst -> Net.Channel.t -> unit Lwt.t) ] ->\n unit Lwt.t", - "params": [ - { "name": "", - "type": "Net.Manager.t" }, - { "name": "", - "type": "[> `Pipe of\n Net.Nettypes.peer_uid *\n (Net.Nettypes.peer_uid -> Net.Channel.t -> unit Lwt.t)\n | `TCPv4 of\n Net.Nettypes.ipv4_src *\n (Net.Nettypes.ipv4_dst -> Net.Channel.t -> unit Lwt.t) ]" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ "Lwt_stream", "Lwt", "Bitstring", "*predef*" ], - "used_by": [ "Dns", "Http" ] } } } \ No newline at end of file diff --git a/data/OS.json b/data/OS.json deleted file mode 100644 index a7e7d70..0000000 --- a/data/OS.json +++ /dev/null @@ -1,462 +0,0 @@ -{ "module": - { "name": "OS", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|0" }, - "info": - { "description": "Operating System interfaces for UNIX" }, - "type": "sig end", - "module_structure": [ - { "module": - { "name": "OS.Activations", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|45" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Activations provides an interface to wait for a file descriptor to become available for either reading or writing" }, - { "type": - { "name": "OS.Activations.fd", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|226" }, - "info": - { "description": "File descriptor" }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "int" } }, - { "value": - { "name": "OS.Activations.read", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|401" }, - "info": - { "description": "Wait for the file descriptor to become ready for reading", - "return": "a thread that blocks until the fd is ready for reading" }, - "type": "OS.Activations.fd -> unit Lwt.t", - "params": [ - { "name": "", - "type": "OS.Activations.fd" } ] } }, - { "value": - { "name": "OS.Activations.write", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|594" }, - "info": - { "description": "Wait for the file descriptor to become ready for writing", - "return": "a thread that blocks until the fd is ready for writing" }, - "type": "OS.Activations.fd -> unit Lwt.t", - "params": [ - { "name": "", - "type": "OS.Activations.fd" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "OS.Clock", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|626" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Clock operations. Currently read-only to retrieve the time in various formats." }, - { "type": - { "name": "OS.Clock.tm", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|743" }, - "info": "", - "params": [ ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "tm_sec", - "mutable": false, - "description": "Seconds 0..60", - "type": "int" }, - { "name": "tm_min", - "mutable": false, - "description": "Minutes 0..59", - "type": "int" }, - { "name": "tm_hour", - "mutable": false, - "description": "Hours 0..23", - "type": "int" }, - { "name": "tm_mday", - "mutable": false, - "description": "Day of month 1..31", - "type": "int" }, - { "name": "tm_mon", - "mutable": false, - "description": "Month of year 0..11", - "type": "int" }, - { "name": "tm_year", - "mutable": false, - "description": "Year - 1900", - "type": "int" }, - { "name": "tm_wday", - "mutable": false, - "description": "Day of week (Sunday is 0)", - "type": "int" }, - { "name": "tm_yday", - "mutable": false, - "description": "Day of year 0..365", - "type": "int" }, - { "name": "tm_isdst", - "mutable": false, - "description": "Daylight time savings in effect", - "type": "bool" } ] } } }, - { "value": - { "name": "OS.Clock.time", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1272" }, - "info": - { "description": "Return the current time since 00:00:00 GMT, Jan. 1, 1970, in seconds." }, - "type": "unit -> float", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "OS.Clock.gmtime", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1402" }, - "info": - { "description": "Convert a time in seconds, as returned by OS.Clock.time, into a date and a time. Assumes UTC (Coordinated Universal Time), also known as GMT." }, - "type": "float -> OS.Clock.tm", - "params": [ - { "name": "", - "type": "float" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "OS.Time", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1607" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "value": - { "name": "OS.Time.restart_threads", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1627" }, - "info": "", - "type": "(unit -> float) -> unit", - "params": [ - { "name": "", - "type": "unit -> float" } ] } }, - { "value": - { "name": "OS.Time.select_next", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1672" }, - "info": "", - "type": "(unit -> float) -> float option", - "params": [ - { "name": "", - "type": "unit -> float" } ] } }, - { "value": - { "name": "OS.Time.sleep", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1722" }, - "info": "", - "type": "float -> unit Lwt.t", - "params": [ - { "name": "", - "type": "float" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "OS.Console", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1758" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Text console input/output operations." }, - { "type": - { "name": "OS.Console.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1875" }, - "info": - { "description": "Abstract type of a console instance" }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "OS.Console.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|1945" }, - "info": - { "description": "The default console, attached from the start of the program" }, - "type": "OS.Console.t", - "params": [ ] } }, - { "value": - { "name": "OS.Console.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2014" }, - "info": - { "description": "Create an additional console. Not implemented yet." }, - "type": "unit -> OS.Console.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "OS.Console.write", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2094" }, - "info": - { "description": "Write a string with offset/length to the console" }, - "type": "OS.Console.t -> string -> int -> int -> unit", - "params": [ - { "name": "", - "type": "OS.Console.t" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "OS.Console.sync_write", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2217" }, - "info": - { "description": "Same as OS.Console.write except that the operation is synchronous" }, - "type": "OS.Console.t -> string -> int -> int -> unit Lwt.t", - "params": [ - { "name": "", - "type": "OS.Console.t" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "OS.Console.log", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2275" }, - "info": "", - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "OS.Console.log_s", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2301" }, - "info": "", - "type": "string -> unit Lwt.t", - "params": [ - { "name": "", - "type": "string" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "OS.Netif", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2338" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "OS.Netif.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2364" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "OS.Netif.id", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2371" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "OS.Netif.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2374" }, - "info": "", - "type": "OS.Netif.id -> OS.Netif.t Lwt.t", - "params": [ - { "name": "", - "type": "OS.Netif.id" } ] } }, - { "value": - { "name": "OS.Netif.listen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2401" }, - "info": "", - "type": "OS.Netif.t -> (Bitstring.t -> unit Lwt.t) -> unit Lwt.t", - "params": [ - { "name": "", - "type": "OS.Netif.t" }, - { "name": "", - "type": "Bitstring.t -> unit Lwt.t" } ] } }, - { "value": - { "name": "OS.Netif.destroy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2461" }, - "info": "", - "type": "OS.Netif.t -> unit Lwt.t", - "params": [ - { "name": "", - "type": "OS.Netif.t" } ] } }, - { "value": - { "name": "OS.Netif.output", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2491" }, - "info": "", - "type": "OS.Netif.t -> Bitstring.t list -> unit Lwt.t", - "params": [ - { "name": "", - "type": "OS.Netif.t" }, - { "name": "", - "type": "Bitstring.t list" } ] } }, - { "value": - { "name": "OS.Netif.enumerate", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2540" }, - "info": "", - "type": "unit -> OS.Netif.id list Lwt.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "OS.Netif.mac", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2578" }, - "info": "", - "type": "OS.Netif.t -> string", - "params": [ - { "name": "", - "type": "OS.Netif.t" } ] } }, - { "value": - { "name": "OS.Netif.string_of_id", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2600" }, - "info": "", - "type": "OS.Netif.id -> string", - "params": [ - { "name": "", - "type": "OS.Netif.id" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "OS.Main", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2636" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "value": - { "name": "OS.Main.run", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2656" }, - "info": "", - "type": "unit Lwt.t -> unit", - "params": [ - { "name": "", - "type": "unit Lwt.t" } ] } }, - { "value": - { "name": "OS.Main.set_control_thread", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2685" }, - "info": "", - "type": "unit Lwt.t -> unit", - "params": [ - { "name": "", - "type": "unit Lwt.t" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "module": - { "name": "OS.Blkif", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2732" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "Dummy Block module, not implemented yet" }, - { "type": - { "name": "OS.Blkif.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2806" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "OS.Blkif.id", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2813" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "OS.Blkif.enumerate", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2817" }, - "info": "", - "type": "unit -> OS.Blkif.id list Lwt.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "OS.Blkif.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oS.mli|2854" }, - "info": "", - "type": "OS.Blkif.id -> (OS.Blkif.t * unit Lwt.t) Lwt.t", - "params": [ - { "name": "", - "type": "OS.Blkif.id" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ "Lwt", "Bitstring" ], - "used_by": [ "Block" ] } } } \ No newline at end of file diff --git a/data/Obj.json b/data/Obj.json deleted file mode 100644 index e084432..0000000 --- a/data/Obj.json +++ /dev/null @@ -1,345 +0,0 @@ -{ "module": - { "name": "Obj", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|0" }, - "info": - { "description": "Operations on internal representations of values.

Not for the casual user." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Obj.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1038" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Obj.repr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1041" }, - "info": "", - "type": "'a -> Obj.t", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Obj.obj", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1079" }, - "info": "", - "type": "Obj.t -> 'a", - "params": [ - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.magic", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1116" }, - "info": "", - "type": "'a -> 'b", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Obj.is_block", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1156" }, - "info": "", - "type": "Obj.t -> bool", - "params": [ - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.is_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1208" }, - "info": "", - "type": "Obj.t -> bool", - "params": [ - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1252" }, - "info": "", - "type": "Obj.t -> int", - "params": [ - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.set_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1293" }, - "info": "", - "type": "Obj.t -> int -> unit", - "params": [ - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Obj.size", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1350" }, - "info": "", - "type": "Obj.t -> int", - "params": [ - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.field", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1389" }, - "info": "", - "type": "Obj.t -> int -> Obj.t", - "params": [ - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Obj.set_field", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1435" }, - "info": "", - "type": "Obj.t -> int -> Obj.t -> unit", - "params": [ - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.double_field", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1497" }, - "info": "", - "type": "Obj.t -> int -> float", - "params": [ - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Obj.set_double_field", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1555" }, - "info": "", - "type": "Obj.t -> int -> float -> unit", - "params": [ - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Obj.new_block", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1625" }, - "info": "", - "type": "int -> int -> Obj.t", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Obj.dup", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1681" }, - "info": "", - "type": "Obj.t -> Obj.t", - "params": [ - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.truncate", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1720" }, - "info": "", - "type": "Obj.t -> int -> unit", - "params": [ - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Obj.add_offset", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1779" }, - "info": "", - "type": "Obj.t -> Int32.t -> Obj.t", - "params": [ - { "name": "", - "type": "Obj.t" }, - { "name": "", - "type": "Int32.t" } ] } }, - { "value": - { "name": "Obj.lazy_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1873" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.closure_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1892" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.object_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1914" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.infix_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1935" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.forward_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1955" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.no_scan_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1977" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.abstract_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|1999" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.string_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2022" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.double_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2043" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.double_array_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2064" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.custom_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2091" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.final_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2112" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.int_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2151" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.out_of_heap_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2169" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Obj.unaligned_tag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2195" }, - "info": "", - "type": "int", - "params": [ ] } }, - { "comment": "The following two functions are deprecated. Use module Marshal instead." }, - { "value": - { "name": "Obj.marshal", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2350" }, - "info": "", - "type": "Obj.t -> string", - "params": [ - { "name": "", - "type": "Obj.t" } ] } }, - { "value": - { "name": "Obj.unmarshal", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/obj.mli|2376" }, - "info": "", - "type": "string -> int -> Obj.t * int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } } ], - "dependencies": - { "uses": [ "Int32" ], - "used_by": [ "Printf", "Parsing", "CamlinternalOO", "CamlinternalMod" ] } } } \ No newline at end of file diff --git a/data/Oo.json b/data/Oo.json deleted file mode 100644 index 93c1111..0000000 --- a/data/Oo.json +++ /dev/null @@ -1,35 +0,0 @@ -{ "module": - { "name": "Oo", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oo.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oo.mli|0" }, - "info": - { "description": "Operations on objects" }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Oo.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oo.mli|975" }, - "info": - { "description": "Oo.copy o returns a copy of object o, that is a fresh object with the same methods and instance variables as o" }, - "type": "(< .. > as 'a) -> 'a", - "params": [ - { "name": "", - "type": "< .. >" } ] } }, - { "value": - { "name": "Oo.id", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/oo.mli|1136" }, - "info": - { "description": "Return an integer identifying this object, unique for the current execution of the program." }, - "type": "< .. > -> int", - "params": [ - { "name": "", - "type": "< .. >" } ] } } ], - "dependencies": - { "uses": [ "CamlinternalOO" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Parsing.json b/data/Parsing.json deleted file mode 100644 index fbe9a49..0000000 --- a/data/Parsing.json +++ /dev/null @@ -1,131 +0,0 @@ -{ "module": - { "name": "Parsing", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|0" }, - "info": - { "description": "The run-time library for parsers generated by ocamlyacc." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Parsing.symbol_start", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|1017" }, - "info": - { "description": "symbol_start and Parsing.symbol_end are to be called in the action part of a grammar rule only. They return the offset of the string that matches the left-hand side of the rule: symbol_start() returns the offset of the first character; symbol_end() returns the offset after the last character. The first character in a file is at offset 0." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Parsing.symbol_end", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|1420" }, - "info": - { "description": "See Parsing.symbol_start." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Parsing.rhs_start", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|1486" }, - "info": - { "description": "Same as Parsing.symbol_start and Parsing.symbol_end, but return the offset of the string matching the nth item on the right-hand side of the rule, where n is the integer parameter to rhs_start and rhs_end. n is 1 for the leftmost item." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Parsing.rhs_end", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|1782" }, - "info": - { "description": "See Parsing.rhs_start." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Parsing.symbol_start_pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|1841" }, - "info": - { "description": "Same as symbol_start, but return a position instead of an offset." }, - "type": "unit -> Lexing.position", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Parsing.symbol_end_pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|1968" }, - "info": - { "description": "Same as symbol_end, but return a position instead of an offset." }, - "type": "unit -> Lexing.position", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Parsing.rhs_start_pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|2089" }, - "info": - { "description": "Same as rhs_start, but return a position instead of an offset." }, - "type": "int -> Lexing.position", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Parsing.rhs_end_pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|2207" }, - "info": - { "description": "Same as rhs_end, but return a position instead of an offset." }, - "type": "int -> Lexing.position", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Parsing.clear_parser", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|2321" }, - "info": - { "description": "Empty the parser stack. Call it just after a parsing function has returned, to remove all pointers from the parser stack to structures that were built by semantic actions during parsing. This is optional, but lowers the memory requirements of the programs." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "exception": - { "name": "Parsing.Parse_error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|2630" }, - "info": - { "description": "Raised when a parser encounters a syntax error. Can also be raised from the action part of a grammar rule, to initiate error recovery." } } }, - { "value": - { "name": "Parsing.set_trace", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/parsing.mli|2801" }, - "info": - { "description": "Control debugging support for ocamlyacc-generated parsers. After Parsing.set_trace true, the pushdown automaton that executes the parsers prints a trace of its actions (reading a token, shifting a state, reducing by a rule) on standard output. Parsing.set_trace false turns this debugging trace off. The boolean returned is the previous state of the trace flag.", - "since": "3.11.0" }, - "type": "bool -> bool", - "params": [ - { "name": "", - "type": "bool" } ] } } ], - "dependencies": - { "uses": [ "Obj", "Lexing" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Pervasives.json b/data/Pervasives.json deleted file mode 100644 index 01b4145..0000000 --- a/data/Pervasives.json +++ /dev/null @@ -1,2061 +0,0 @@ -{ "module": - { "name": "Pervasives", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|0" }, - "info": - { "description": "The initially opened module.

This module provides the basic operations over the built-in types (numbers, booleans, strings, exceptions, references, lists, arrays, input-output channels, ...).

This module is automatically opened at the beginning of each compilation. All components of this module can therefore be referred by their short name, without prefixing them by Pervasives." }, - "type": "sig end", - "module_structure": [ - { "comment": "
Exceptions
" }, - { "value": - { "name": "Pervasives.raise", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|1385" }, - "info": - { "description": "Raise the given exception value" }, - "type": "exn -> 'a", - "params": [ - { "name": "", - "type": "exn" } ] } }, - { "value": - { "name": "Pervasives.invalid_arg", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|1463" }, - "info": - { "description": "Raise exception Invalid_argument with the given string." }, - "type": "string -> 'a", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.failwith", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|1560" }, - "info": - { "description": "Raise exception Failure with the given string." }, - "type": "string -> 'a", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "exception": - { "name": "Pervasives.Exit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|1645" }, - "info": - { "description": "The Exit exception is not raised by any library function. It is provided for use in your programs." } } }, - { "comment": "
Comparisons
" }, - { "value": - { "name": "Pervasives.(=)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|1798" }, - "info": - { "description": "e1 = e2 tests for structural equality of e1 and e2. Mutable structures (e.g. references and arrays) are equal if and only if their current contents are structurally equal, even if the two mutable objects are not the same physical object. Equality between functional values raises Invalid_argument. Equality between cyclic data structures may not terminate." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(<>)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|2231" }, - "info": - { "description": "Negation of Pervasives.(=)." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(<)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|2319" }, - "info": - { "description": "See Pervasives.(>=)." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(>)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|2399" }, - "info": - { "description": "See Pervasives.(>=)." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(<=)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|2482" }, - "info": - { "description": "See Pervasives.(>=)." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(>=)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|2564" }, - "info": - { "description": "Structural ordering functions. These functions coincide with the usual orderings over integers, characters, strings and floating-point numbers, and extend them to a total ordering over all types. The ordering is compatible with (=). As in the case of (=), mutable structures are compared by contents. Comparison between functional values raises Invalid_argument. Comparison between cyclic structures may not terminate." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|3071" }, - "info": - { "description": "compare x y returns 0 if x is equal to y, a negative integer if x is less than y, and a positive integer if x is greater than y. The ordering implemented by compare is compatible with the comparison predicates =, < and > defined above, with one difference on the treatment of the float value Pervasives.nan. Namely, the comparison predicates treat nan as different from any other float value, including itself; while compare treats nan as equal to itself and less than any other float value. This treatment of nan ensures that compare defines a total ordering relation.

compare applied to functional values may raise Invalid_argument. compare applied to cyclic structures may not terminate.

The compare function can be used as the comparison function required by the Set.Make and Map.Make functors, as well as the List.sort and Array.sort functions." }, - "type": "'a -> 'a -> int", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.min", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|4082" }, - "info": - { "description": "Return the smaller of the two arguments. The result is unspecified if one of the arguments contains the float value nan." }, - "type": "'a -> 'a -> 'a", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.max", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|4246" }, - "info": - { "description": "Return the greater of the two arguments. The result is unspecified if one of the arguments contains the float value nan." }, - "type": "'a -> 'a -> 'a", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(==)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|4410" }, - "info": - { "description": "e1 == e2 tests for physical equality of e1 and e2. On mutable types such as references, arrays, strings, records with mutable fields and objects with mutable instance variables, e1 == e2 is true if and only if physical modification of e1 also affects e2. On non-mutable types, the behavior of (==) is implementation-dependent; however, it is guaranteed that e1 == e2 implies compare e1 e2 = 0." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(!=)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|4894" }, - "info": - { "description": "Negation of Pervasives.(==)." }, - "type": "'a -> 'a -> bool", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } }, - { "comment": "
Boolean operations
" }, - { "value": - { "name": "Pervasives.not", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|5012" }, - "info": - { "description": "The boolean negation." }, - "type": "bool -> bool", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Pervasives.(&&)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|5083" }, - "info": - { "description": "The boolean ``and''. Evaluation is sequential, left-to-right: in e1 && e2, e1 is evaluated first, and if it returns false, e2 is not evaluated at all." }, - "type": "bool -> bool -> bool", - "params": [ - { "name": "", - "type": "bool" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Pervasives.(&)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|5308" }, - "info": - { "deprecated": "Pervasives.(&&) should be used instead." }, - "type": "bool -> bool -> bool", - "params": [ - { "name": "", - "type": "bool" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Pervasives.(||)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|5424" }, - "info": - { "description": "The boolean ``or''. Evaluation is sequential, left-to-right: in e1 || e2, e1 is evaluated first, and if it returns true, e2 is not evaluated at all." }, - "type": "bool -> bool -> bool", - "params": [ - { "name": "", - "type": "bool" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Pervasives.(or)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|5646" }, - "info": - { "deprecated": "Pervasives.(||) should be used instead." }, - "type": "bool -> bool -> bool", - "params": [ - { "name": "", - "type": "bool" }, - { "name": "", - "type": "bool" } ] } }, - { "comment": "
Integer arithmetic
" }, - { "comment": "Integers are 31 bits wide (or 63 bits on 64-bit processors). All operations are taken modulo 231 (or 263). They do not fail on overflow." }, - { "value": - { "name": "Pervasives.(~-)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|5950" }, - "info": - { "description": "Unary negation. You can also write - e instead of ~- e." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(~+)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6059" }, - "info": - { "description": "Unary addition. You can also write + e instead of ~+ e.", - "since": "3.12.0" }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.succ", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6188" }, - "info": - { "description": "succ x is x + 1." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.pred", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6257" }, - "info": - { "description": "pred x is x - 1." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(+)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6326" }, - "info": - { "description": "Integer addition." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(-)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6399" }, - "info": - { "description": "Integer subtraction." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.( * )", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6475" }, - "info": - { "description": "Integer multiplication." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(/)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6554" }, - "info": - { "description": "Integer division. Raise Division_by_zero if the second argument is 0. Integer division rounds the real quotient of its arguments towards zero. More precisely, if x >= 0 and y > 0, x / y is the greatest integer less than or equal to the real quotient of x by y. Moreover, (- x) / y = x / (- y) = - (x / y)." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(mod)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|6946" }, - "info": - { "description": "Integer remainder. If y is not zero, the result of x mod y satisfies the following properties: x = (x / y) * y + x mod y and abs(x mod y) <= abs(y) - 1. If y = 0, x mod y raises Division_by_zero. Note that x mod y is negative only if x < 0. Raise Division_by_zero if y is zero." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.abs", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7322" }, - "info": - { "description": "Return the absolute value of the argument. Note that this may be negative if the argument is min_int." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.max_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7458" }, - "info": - { "description": "The greatest representable integer." }, - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Pervasives.min_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7520" }, - "info": - { "description": "The smallest representable integer." }, - "type": "int", - "params": [ ] } }, - { "comment": "Bitwise operations" }, - { "value": - { "name": "Pervasives.(land)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7614" }, - "info": - { "description": "Bitwise logical and." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(lor)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7693" }, - "info": - { "description": "Bitwise logical or." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(lxor)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7769" }, - "info": - { "description": "Bitwise logical exclusive or." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.lnot", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7857" }, - "info": - { "description": "Bitwise logical negation." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(lsl)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|7913" }, - "info": - { "description": "n lsl m shifts n to the left by m bits. The result is unspecified if m < 0 or m >= bitsize, where bitsize is 32 on a 32-bit platform and 64 on a 64-bit platform." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(lsr)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|8157" }, - "info": - { "description": "n lsr m shifts n to the right by m bits. This is a logical shift: zeroes are inserted regardless of the sign of n. The result is unspecified if m < 0 or m >= bitsize." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.(asr)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|8402" }, - "info": - { "description": "n asr m shifts n to the right by m bits. This is an arithmetic shift: the sign bit of n is replicated. The result is unspecified if m < 0 or m >= bitsize." }, - "type": "int -> int -> int", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "comment": "
Floating-point arithmetic


Caml's floating-point numbers follow the IEEE 754 standard, using double precision (64 bits) numbers. Floating-point operations never raise an exception on overflow, underflow, division by zero, etc. Instead, special IEEE numbers are returned as appropriate, such as infinity for 1.0 /. 0.0, neg_infinity for -1.0 /. 0.0, and nan (``not a number'') for 0.0 /. 0.0. These special numbers then propagate through floating-point computations as expected: for instance, 1.0 /. infinity is 0.0, and any arithmetic operation with nan as argument returns nan as result." }, - { "value": - { "name": "Pervasives.(~-.)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|9286" }, - "info": - { "description": "Unary negation. You can also write -. e instead of ~-. e." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.(~+.)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|9404" }, - "info": - { "description": "Unary addition. You can also write +. e instead of ~+. e.", - "since": "3.12.0" }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.(+.)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|9540" }, - "info": - { "description": "Floating-point addition" }, - "type": "float -> float -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.(-.)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|9628" }, - "info": - { "description": "Floating-point subtraction" }, - "type": "float -> float -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.( *. )", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|9719" }, - "info": - { "description": "Floating-point multiplication" }, - "type": "float -> float -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.(/.)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|9813" }, - "info": - { "description": "Floating-point division." }, - "type": "float -> float -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.( ** )", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|9902" }, - "info": - { "description": "Exponentiation." }, - "type": "float -> float -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.sqrt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10003" }, - "info": - { "description": "Square root." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.exp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10090" }, - "info": - { "description": "Exponential." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.log", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10174" }, - "info": - { "description": "Natural logarithm." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.log10", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10264" }, - "info": - { "description": "Base 10 logarithm." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.expm1", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10360" }, - "info": - { "description": "expm1 x computes exp x -. 1.0, giving numerically-accurate results even if x is close to 0.0.", - "since": "3.12.0" }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.log1p", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10566" }, - "info": - { "description": "log1p x computes log(1.0 +. x) (natural logarithm), giving numerically-accurate results even if x is close to 0.0.", - "since": "3.12.0" }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.cos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10793" }, - "info": - { "description": "Cosine. Argument is in radians." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.sin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10897" }, - "info": - { "description": "Sine. Argument is in radians." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.tan", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|10999" }, - "info": - { "description": "Tangent. Argument is in radians." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.acos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|11104" }, - "info": - { "description": "Arc cosine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between 0.0 and pi." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.asin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|11302" }, - "info": - { "description": "Arc sine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between -pi/2 and pi/2." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.atan", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|11502" }, - "info": - { "description": "Arc tangent. Result is in radians and is between -pi/2 and pi/2." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.atan2", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|11649" }, - "info": - { "description": "atan x y returns the arc tangent of y /. x. The signs of x and y are used to determine the quadrant of the result. Result is in radians and is between -pi and pi." }, - "type": "float -> float -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.cosh", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|11919" }, - "info": - { "description": "Hyperbolic cosine. Argument is in radians." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.sinh", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|12037" }, - "info": - { "description": "Hyperbolic sine. Argument is in radians." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.tanh", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|12153" }, - "info": - { "description": "Hyperbolic tangent. Argument is in radians." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.ceil", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|12272" }, - "info": - { "description": "Round above to an integer value. ceil f returns the least integer value greater than or equal to f. The result is returned as a float." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.floor", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|12493" }, - "info": - { "description": "Round below to an integer value. floor f returns the greatest integer value less than or equal to f. The result is returned as a float." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.abs_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|12722" }, - "info": - { "description": "abs_float f returns the absolute value of f." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.mod_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|12829" }, - "info": - { "description": "mod_float a b returns the remainder of a with respect to b. The returned value is a -. n *. b, where n is the quotient a /. b rounded towards zero to an integer." }, - "type": "float -> float -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.frexp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|13098" }, - "info": - { "description": "frexp f returns the pair of the significant and the exponent of f. When f is zero, the significant x and the exponent n of f are equal to zero. When f is non-zero, they are defined by f = x *. 2 ** n and 0.5 <= x < 1.0." }, - "type": "float -> float * int", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.ldexp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|13417" }, - "info": - { "description": "ldexp x n returns x *. 2 ** n." }, - "type": "float -> int -> float", - "params": [ - { "name": "", - "type": "float" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.modf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|13520" }, - "info": - { "description": "modf f returns the pair of the fractional and integral part of f." }, - "type": "float -> float * float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|13660" }, - "info": - { "description": "Same as Pervasives.float_of_int." }, - "type": "int -> float", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.float_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|13750" }, - "info": - { "description": "Convert an integer to floating-point." }, - "type": "int -> float", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.truncate", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|13849" }, - "info": - { "description": "Same as Pervasives.int_of_float." }, - "type": "float -> int", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.int_of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|13942" }, - "info": - { "description": "Truncate the given floating-point number to an integer. The result is unspecified if the argument is nan or falls outside the range of representable integers." }, - "type": "float -> int", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.infinity", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|14170" }, - "info": - { "description": "Positive infinity." }, - "type": "float", - "params": [ ] } }, - { "value": - { "name": "Pervasives.neg_infinity", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|14218" }, - "info": - { "description": "Negative infinity." }, - "type": "float", - "params": [ ] } }, - { "value": - { "name": "Pervasives.nan", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|14270" }, - "info": - { "description": "A special floating-point value denoting the result of an undefined operation such as 0.0 /. 0.0. Stands for ``not a number''. Any floating-point operation with nan as argument returns nan as result. As for floating-point comparisons, =, <, <=, > and >= return false and <> returns true if one or both of their arguments is nan." }, - "type": "float", - "params": [ ] } }, - { "value": - { "name": "Pervasives.max_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|14664" }, - "info": - { "description": "The largest positive finite value of type float." }, - "type": "float", - "params": [ ] } }, - { "value": - { "name": "Pervasives.min_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|14745" }, - "info": - { "description": "The smallest positive, non-zero, non-denormalized value of type float." }, - "type": "float", - "params": [ ] } }, - { "value": - { "name": "Pervasives.epsilon_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|14848" }, - "info": - { "description": "The difference between 1.0 and the smallest exactly representable floating-point number greater than 1.0." }, - "type": "float", - "params": [ ] } }, - { "type": - { "name": "Pervasives.fpclass", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|15001" }, - "info": - { "description": "The five classes of floating-point numbers, as determined by the Pervasives.classify_float function." }, - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "FP_normal", - "description": "Normal number, none of the below", - "type": [ ] }, - { "name": "FP_subnormal", - "description": "Number very close to 0.0, has reduced precision", - "type": [ ] }, - { "name": "FP_zero", - "description": "Number is 0.0 or -0.0", - "type": [ ] }, - { "name": "FP_infinite", - "description": "Number is positive or negative infinity", - "type": [ ] }, - { "name": "FP_nan", - "description": "Not a number: result of an undefined operation", - "type": [ ] } ] } } }, - { "value": - { "name": "Pervasives.classify_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|15471" }, - "info": - { "description": "Return the class of the given floating-point number: normal, subnormal, zero, infinite, or not a number." }, - "type": "float -> Pervasives.fpclass", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "comment": "
String operations


More string operations are provided in module String." }, - { "value": - { "name": "Pervasives.(^)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|15746" }, - "info": - { "description": "String concatenation." }, - "type": "string -> string -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "string" } ] } }, - { "comment": "
Character operations


More character operations are provided in module Char." }, - { "value": - { "name": "Pervasives.int_of_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|15911" }, - "info": - { "description": "Return the ASCII code of the argument." }, - "type": "char -> int", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Pervasives.char_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|16007" }, - "info": - { "description": "Return the character with the given ASCII code. Raise Invalid_argument \"char_of_int\" if the argument is outside the range 0--255." }, - "type": "int -> char", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "comment": "
Unit operations
" }, - { "value": - { "name": "Pervasives.ignore", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|16212" }, - "info": - { "description": "Discard the value of its argument and return (). For instance, ignore(f x) discards the result of the side-effecting function f. It is equivalent to f x; (), except that the latter may generate a compiler warning; writing ignore(f x) instead avoids the warning." }, - "type": "'a -> unit", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "comment": "
String conversion functions
" }, - { "value": - { "name": "Pervasives.string_of_bool", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|16590" }, - "info": - { "description": "Return the string representation of a boolean." }, - "type": "bool -> string", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Pervasives.bool_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|16681" }, - "info": - { "description": "Convert the given string to a boolean. Raise Invalid_argument \"bool_of_string\" if the string is not \"true\" or \"false\"." }, - "type": "string -> bool", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.string_of_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|16856" }, - "info": - { "description": "Return the string representation of an integer, in decimal." }, - "type": "int -> string", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.int_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|16958" }, - "info": - { "description": "Convert the given string to an integer. The string is read in decimal (by default) or in hexadecimal (if it begins with 0x or 0X), octal (if it begins with 0o or 0O), or binary (if it begins with 0b or 0B). Raise Failure \"int_of_string\" if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integers representable in type int." }, - "type": "string -> int", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.string_of_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|17451" }, - "info": - { "description": "Return the string representation of a floating-point number." }, - "type": "float -> string", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.float_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|17558" }, - "info": - { "description": "Convert the given string to a float. Raise Failure \"float_of_string\" if the given string is not a valid representation of a float." }, - "type": "string -> float", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "comment": "
Pair operations
" }, - { "value": - { "name": "Pervasives.fst", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|17800" }, - "info": - { "description": "Return the first component of a pair." }, - "type": "'a * 'b -> 'a", - "params": [ - { "tuple": - { "type": "'a * 'b", - "contents": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } } ] } }, - { "value": - { "name": "Pervasives.snd", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|17887" }, - "info": - { "description": "Return the second component of a pair." }, - "type": "'a * 'b -> 'b", - "params": [ - { "tuple": - { "type": "'a * 'b", - "contents": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a" } ] } } ] } }, - { "comment": "
List operations


More list operations are provided in module List." }, - { "value": - { "name": "Pervasives.(@)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18061" }, - "info": - { "description": "List concatenation." }, - "type": "'a list -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } }, - { "comment": "
Input/output
" }, - { "type": - { "name": "Pervasives.in_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18162" }, - "info": - { "description": "The type of input channel." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "Pervasives.out_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18213" }, - "info": - { "description": "The type of output channel." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Pervasives.stdin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18261" }, - "info": - { "description": "The standard input for the process." }, - "type": "Pervasives.in_channel", - "params": [ ] } }, - { "value": - { "name": "Pervasives.stdout", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18328" }, - "info": - { "description": "The standard output for the process." }, - "type": "Pervasives.out_channel", - "params": [ ] } }, - { "value": - { "name": "Pervasives.stderr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18398" }, - "info": - { "description": "The standard error ouput for the process." }, - "type": "Pervasives.out_channel", - "params": [ ] } }, - { "comment": "Output functions on standard output" }, - { "value": - { "name": "Pervasives.print_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18522" }, - "info": - { "description": "Print a character on standard output." }, - "type": "char -> unit", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Pervasives.print_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18598" }, - "info": - { "description": "Print a string on standard output." }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.print_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18675" }, - "info": - { "description": "Print an integer, in decimal, on standard output." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.print_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18761" }, - "info": - { "description": "Print a floating-point number, in decimal, on standard output." }, - "type": "float -> unit", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.print_endline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|18864" }, - "info": - { "description": "Print a string, followed by a newline character, on standard output and flush standard output." }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.print_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19005" }, - "info": - { "description": "Print a newline character on standard output, and flush standard output. This can be used to simulate line buffering of standard output." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "Output functions on standard error" }, - { "value": - { "name": "Pervasives.prerr_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19237" }, - "info": - { "description": "Print a character on standard error." }, - "type": "char -> unit", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Pervasives.prerr_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19312" }, - "info": - { "description": "Print a string on standard error." }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.prerr_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19388" }, - "info": - { "description": "Print an integer, in decimal, on standard error." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.prerr_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19473" }, - "info": - { "description": "Print a floating-point number, in decimal, on standard error." }, - "type": "float -> unit", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Pervasives.prerr_endline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19575" }, - "info": - { "description": "Print a string, followed by a newline character on standard error and flush standard error." }, - "type": "string -> unit", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.prerr_newline", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19713" }, - "info": - { "description": "Print a newline character on standard error, and flush standard error." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "Input functions on standard input" }, - { "value": - { "name": "Pervasives.read_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|19875" }, - "info": - { "description": "Flush standard output, then read characters from standard input until a newline character is encountered. Return the string of all characters read, without the newline character at the end." }, - "type": "unit -> string", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Pervasives.read_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|20110" }, - "info": - { "description": "Flush standard output, then read one line from standard input and convert it to an integer. Raise Failure \"int_of_string\" if the line read is not a valid representation of an integer." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Pervasives.read_float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|20337" }, - "info": - { "description": "Flush standard output, then read one line from standard input and convert it to a floating-point number. The result is unspecified if the line read is not a valid representation of a floating-point number." }, - "type": "unit -> float", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "General output functions" }, - { "type": - { "name": "Pervasives.open_flag", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|20634" }, - "info": - { "description": "Opening modes for Pervasives.open_out_gen and Pervasives.open_in_gen." }, - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Open_rdonly", - "description": "open for reading.", - "type": [ ] }, - { "name": "Open_wronly", - "description": "open for writing.", - "type": [ ] }, - { "name": "Open_append", - "description": "open for appending: always write at end of file.", - "type": [ ] }, - { "name": "Open_creat", - "description": "create the file if it does not exist.", - "type": [ ] }, - { "name": "Open_trunc", - "description": "empty the file if it already exists.", - "type": [ ] }, - { "name": "Open_excl", - "description": "fail if Open_creat and the file already exists.", - "type": [ ] }, - { "name": "Open_binary", - "description": "open in binary mode (no conversion).", - "type": [ ] }, - { "name": "Open_text", - "description": "open in text mode (may perform conversions).", - "type": [ ] }, - { "name": "Open_nonblock", - "description": "open in non-blocking mode.", - "type": [ ] } ] } } }, - { "value": - { "name": "Pervasives.open_out", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|21301" }, - "info": - { "description": "Open the named file for writing, and return a new output channel on that file, positionned at the beginning of the file. The file is truncated to zero length if it already exists. It is created if it does not already exists. Raise Sys_error if the file could not be opened." }, - "type": "string -> Pervasives.out_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.open_out_bin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|21634" }, - "info": - { "description": "Same as Pervasives.open_out, but the file is opened in binary mode, so that no translation takes place during writes. On operating systems that do not distinguish between text mode and binary mode, this function behaves like Pervasives.open_out." }, - "type": "string -> Pervasives.out_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.open_out_gen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|21944" }, - "info": - { "description": "open_out_gen mode perm filename opens the named file for writing, as described above. The extra argument mode specify the opening mode. The extra argument perm specifies the file permissions, in case the file must be created. Pervasives.open_out and Pervasives.open_out_bin are special cases of this function." }, - "type": "Pervasives.open_flag list -> int -> string -> Pervasives.out_channel", - "params": [ - { "name": "", - "type": "Pervasives.open_flag list" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.flush", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|22355" }, - "info": - { "description": "Flush the buffer associated with the given output channel, performing all pending writes on that channel. Interactive programs must be careful about flushing standard output and standard error at the right time." }, - "type": "Pervasives.out_channel -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Pervasives.flush_all", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|22616" }, - "info": - { "description": "Flush all open output channels; ignore errors." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Pervasives.output_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|22700" }, - "info": - { "description": "Write the character on the given output channel." }, - "type": "Pervasives.out_channel -> char -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Pervasives.output_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|22803" }, - "info": - { "description": "Write the string on the given output channel." }, - "type": "Pervasives.out_channel -> string -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.output", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|22907" }, - "info": - { "description": "output oc buf pos len writes len characters from string buf, starting at offset pos, to the given output channel oc. Raise Invalid_argument \"output\" if pos and len do not designate a valid substring of buf." }, - "type": "Pervasives.out_channel -> string -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.output_byte", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|23206" }, - "info": - { "description": "Write one 8-bit integer (as the single character with that code) on the given output channel. The given integer is taken modulo 256." }, - "type": "Pervasives.out_channel -> int -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.output_binary_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|23398" }, - "info": - { "description": "Write one integer in binary format (4 bytes, big-endian) on the given output channel. The given integer is taken modulo 232. The only reliable way to read it back is through the Pervasives.input_binary_int function. The format is compatible across all machines for a given version of Objective Caml." }, - "type": "Pervasives.out_channel -> int -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.output_value", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|23778" }, - "info": - { "description": "Write the representation of a structured value of any type to a channel. Circularities and sharing inside the value are detected and preserved. The object can be read back, by the function Pervasives.input_value. See the description of module Marshal for more information. Pervasives.output_value is equivalent to Marshal.to_channel with an empty list of flags." }, - "type": "Pervasives.out_channel -> 'a -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.seek_out", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|24220" }, - "info": - { "description": "seek_out chan pos sets the current writing position to pos for channel chan. This works only for regular files. On files of other kinds (such as terminals, pipes and sockets), the behavior is unspecified." }, - "type": "Pervasives.out_channel -> int -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.pos_out", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|24490" }, - "info": - { "description": "Return the current writing position for the given channel. Does not work on channels opened with the Open_append flag (returns unspecified results)." }, - "type": "Pervasives.out_channel -> int", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Pervasives.out_channel_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|24691" }, - "info": - { "description": "Return the size (number of characters) of the regular file on which the given channel is opened. If the channel is opened on a file that is not a regular file, the result is meaningless." }, - "type": "Pervasives.out_channel -> int", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Pervasives.close_out", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|24938" }, - "info": - { "description": "Close the given channel, flushing all buffered write operations. Output functions raise a Sys_error exception when they are applied to a closed output channel, except close_out and flush, which do nothing when applied to an already closed channel. Note that close_out may raise Sys_error if the operating system signals an error when flushing or closing." }, - "type": "Pervasives.out_channel -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Pervasives.close_out_noerr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|25362" }, - "info": - { "description": "Same as close_out, but ignore all errors." }, - "type": "Pervasives.out_channel -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Pervasives.set_binary_mode_out", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|25456" }, - "info": - { "description": "set_binary_mode_out oc true sets the channel oc to binary mode: no translations take place during output. set_binary_mode_out oc false sets the channel oc to text mode: depending on the operating system, some translations may take place during output. For instance, under Windows, end-of-lines will be translated from \\n to \\r\\n. This function has no effect under operating systems that do not distinguish between text mode and binary mode." }, - "type": "Pervasives.out_channel -> bool -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "bool" } ] } }, - { "comment": "General input functions" }, - { "value": - { "name": "Pervasives.open_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|26030" }, - "info": - { "description": "Open the named file for reading, and return a new input channel on that file, positionned at the beginning of the file. Raise Sys_error if the file could not be opened." }, - "type": "string -> Pervasives.in_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.open_in_bin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|26250" }, - "info": - { "description": "Same as Pervasives.open_in, but the file is opened in binary mode, so that no translation takes place during reads. On operating systems that do not distinguish between text mode and binary mode, this function behaves like Pervasives.open_in." }, - "type": "string -> Pervasives.in_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.open_in_gen", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|26555" }, - "info": - { "description": "open_in_gen mode perm filename opens the named file for reading, as described above. The extra arguments mode and perm specify the opening mode and file permissions. Pervasives.open_in and Pervasives.open_in_bin are special cases of this function." }, - "type": "Pervasives.open_flag list -> int -> string -> Pervasives.in_channel", - "params": [ - { "name": "", - "type": "Pervasives.open_flag list" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Pervasives.input_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|26899" }, - "info": - { "description": "Read one character from the given input channel. Raise End_of_file if there are no more characters to read." }, - "type": "Pervasives.in_channel -> char", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.input_line", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|27056" }, - "info": - { "description": "Read characters from the given input channel, until a newline character is encountered. Return the string of all characters read, without the newline character at the end. Raise End_of_file if the end of the file is reached at the beginning of line." }, - "type": "Pervasives.in_channel -> string", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|27366" }, - "info": - { "description": "input ic buf pos len reads up to len characters from the given channel ic, storing them in string buf, starting at character number pos. It returns the actual number of characters read, between 0 and len (inclusive). A return value of 0 means that the end of file was reached. A return value between 0 and len exclusive means that not all requested len characters were read, either because no more characters were available at that time, or because the implementation found it convenient to do a partial read; input must be called again to read the remaining characters, if desired. (See also Pervasives.really_input for reading exactly len characters.) Exception Invalid_argument \"input\" is raised if pos and len do not designate a valid substring of buf." }, - "type": "Pervasives.in_channel -> string -> int -> int -> int", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.really_input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|28259" }, - "info": - { "description": "really_input ic buf pos len reads len characters from channel ic, storing them in string buf, starting at character number pos. Raise End_of_file if the end of file is reached before len characters have been read. Raise Invalid_argument \"really_input\" if pos and len do not designate a valid substring of buf." }, - "type": "Pervasives.in_channel -> string -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.input_byte", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|28676" }, - "info": - { "description": "Same as Pervasives.input_char, but return the 8-bit integer representing the character. Raise End_of_file if an end of file was reached." }, - "type": "Pervasives.in_channel -> int", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.input_binary_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|28867" }, - "info": - { "description": "Read an integer encoded in binary format (4 bytes, big-endian) from the given input channel. See Pervasives.output_binary_int. Raise End_of_file if an end of file was reached while reading the integer." }, - "type": "Pervasives.in_channel -> int", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.input_value", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|29132" }, - "info": - { "description": "Read the representation of a structured value, as produced by Pervasives.output_value, and return the corresponding value. This function is identical to Marshal.from_channel; see the description of module Marshal for more information, in particular concerning the lack of type safety." }, - "type": "Pervasives.in_channel -> 'a", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.seek_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|29481" }, - "info": - { "description": "seek_in chan pos sets the current reading position to pos for channel chan. This works only for regular files. On files of other kinds, the behavior is unspecified." }, - "type": "Pervasives.in_channel -> int -> unit", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.pos_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|29706" }, - "info": - { "description": "Return the current reading position for the given channel." }, - "type": "Pervasives.in_channel -> int", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.in_channel_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|29804" }, - "info": - { "description": "Return the size (number of characters) of the regular file on which the given channel is opened. If the channel is opened on a file that is not a regular file, the result is meaningless. The returned size does not take into account the end-of-line translations that can be performed when reading from a channel opened in text mode." }, - "type": "Pervasives.in_channel -> int", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.close_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|30207" }, - "info": - { "description": "Close the given channel. Input functions raise a Sys_error exception when they are applied to a closed input channel, except close_in, which does nothing when applied to an already closed channel. Note that close_in may raise Sys_error if the operating system signals an error." }, - "type": "Pervasives.in_channel -> unit", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.close_in_noerr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|30545" }, - "info": - { "description": "Same as close_in, but ignore all errors." }, - "type": "Pervasives.in_channel -> unit", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.set_binary_mode_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|30636" }, - "info": - { "description": "set_binary_mode_in ic true sets the channel ic to binary mode: no translations take place during input. set_binary_mode_out ic false sets the channel ic to text mode: depending on the operating system, some translations may take place during input. For instance, under Windows, end-of-lines will be translated from \\r\\n to \\n. This function has no effect under operating systems that do not distinguish between text mode and binary mode." }, - "type": "Pervasives.in_channel -> bool -> unit", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" }, - { "name": "", - "type": "bool" } ] } }, - { "comment": "Operations on large files" }, - { "module": - { "name": "Pervasives.LargeFile", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31207" }, - "info": - { "description": "Operations on large files. This sub-module provides 64-bit variants of the channel functions that manipulate file positions and file sizes. By representing positions and sizes by 64-bit integers (type int64) instead of regular integers (type int), these alternate functions allow operating on files whose sizes are greater than max_int." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Pervasives.LargeFile.seek_out", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31236" }, - "info": "", - "type": "Pervasives.out_channel -> int64 -> unit", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Pervasives.LargeFile.pos_out", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31284" }, - "info": "", - "type": "Pervasives.out_channel -> int64", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Pervasives.LargeFile.out_channel_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31323" }, - "info": "", - "type": "Pervasives.out_channel -> int64", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" } ] } }, - { "value": - { "name": "Pervasives.LargeFile.seek_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31373" }, - "info": "", - "type": "Pervasives.in_channel -> int64 -> unit", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" }, - { "name": "", - "type": "int64" } ] } }, - { "value": - { "name": "Pervasives.LargeFile.pos_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31419" }, - "info": "", - "type": "Pervasives.in_channel -> int64", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Pervasives.LargeFile.in_channel_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31456" }, - "info": "", - "type": "Pervasives.in_channel -> int64", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "comment": "
References
" }, - { "type": - { "name": "Pervasives.ref", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|31896" }, - "info": - { "description": "The type of references (mutable indirection cells) containing a value of type 'a." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" } ], - "kind": - { "type": "record", - "private": "false", - "fields": [ - { "name": "contents", - "mutable": true, - "type": "'a" } ] } } }, - { "value": - { "name": "Pervasives.ref", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|32027" }, - "info": - { "description": "Return a fresh reference containing the given value." }, - "type": "'a -> 'a Pervasives.ref", - "params": [ - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.(!)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|32133" }, - "info": - { "description": "!r returns the current contents of reference r. Equivalent to fun r -> r.contents." }, - "type": "'a Pervasives.ref -> 'a", - "params": [ - { "name": "", - "type": "'a Pervasives.ref" } ] } }, - { "value": - { "name": "Pervasives.(:=)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|32275" }, - "info": - { "description": "r := a stores the value of a in reference r. Equivalent to fun r v -> r.contents <- v." }, - "type": "'a Pervasives.ref -> 'a -> unit", - "params": [ - { "name": "", - "type": "'a Pervasives.ref" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Pervasives.incr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|32435" }, - "info": - { "description": "Increment the integer contained in the given reference. Equivalent to fun r -> r := succ !r." }, - "type": "int Pervasives.ref -> unit", - "params": [ - { "name": "", - "type": "int Pervasives.ref" } ] } }, - { "value": - { "name": "Pervasives.decr", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|32583" }, - "info": - { "description": "Decrement the integer contained in the given reference. Equivalent to fun r -> r := pred !r." }, - "type": "int Pervasives.ref -> unit", - "params": [ - { "name": "", - "type": "int Pervasives.ref" } ] } }, - { "comment": "
Operations on format strings
" }, - { "comment": "Format strings are used to read and print data using formatted input functions in module Scanf and formatted output in modules Printf and Format." }, - { "type": - { "name": "Pervasives.format4", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|33439" }, - "info": - { "description": "Format strings have a general and highly polymorphic type ('a, 'b, 'c, 'd, 'e, 'f) format6. Type format6 is built in. The two simplified types, format and format4 below are included for backward compatibility with earlier releases of Objective Caml. 'a is the type of the parameters of the format, 'c is the result type for the \"printf\"-style function, and 'b is the type of the first argument given to %a and %t printing functions." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" }, - { "covariant": "true", - "contravariant": "true", - "type": "'b" }, - { "covariant": "true", - "contravariant": "true", - "type": "'c" }, - { "covariant": "true", - "contravariant": "true", - "type": "'d" } ], - "kind": - { "type": "abstract" }, - "manifest": "('a, 'b, 'c, 'c, 'c, 'd) format6" } }, - { "type": - { "name": "Pervasives.format", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|33505" }, - "info": "", - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'e" }, - { "covariant": "true", - "contravariant": "true", - "type": "'f" }, - { "covariant": "true", - "contravariant": "true", - "type": "'g" } ], - "kind": - { "type": "abstract" }, - "manifest": "('a, 'b, 'c, 'c) Pervasives.format4" } }, - { "value": - { "name": "Pervasives.string_of_format", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|33553" }, - "info": - { "description": "Converts a format string into a string." }, - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6 -> string", - "params": [ - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6" } ] } }, - { "value": - { "name": "Pervasives.format_of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|33667" }, - "info": - { "description": "format_of_string s returns a format string read from the string literal s." }, - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6 -> ('a, 'b, 'c, 'd, 'e, 'f) format6", - "params": [ - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6" } ] } }, - { "value": - { "name": "Pervasives.(^^)", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|33873" }, - "info": - { "description": "f1 ^^ f2 catenates formats f1 and f2. The result is a format that accepts arguments from f1, then arguments from f2." }, - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6 ->\n ('f, 'b, 'c, 'e, 'g, 'h) format6 -> ('a, 'b, 'c, 'd, 'g, 'h) format6", - "params": [ - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6" }, - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6" } ] } }, - { "comment": "
Program termination
" }, - { "value": - { "name": "Pervasives.exit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|34180" }, - "info": - { "description": "Terminate the process, returning the given status code to the operating system: usually 0 to indicate no errors, and a small positive integer to indicate failure. All open output channels are flushed with flush_all. An implicit exit 0 is performed each time a program terminates normally. An implicit exit 2 is performed if the program terminates early because of an uncaught exception." }, - "type": "int -> 'a", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Pervasives.at_exit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/pervasives.mli|34619" }, - "info": - { "description": "Register the given function to be called at program termination time. The functions registered with at_exit will be called when the program executes Pervasives.exit, or terminates, either normally or because of an uncaught exception. The functions are called in ``last in, first out'' order: the function most recently added with at_exit is called first." }, - "type": "(unit -> unit) -> unit", - "params": [ - { "name": "", - "type": "unit -> unit" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Sys", "Scanf", "Format", "Printf" ] } } } \ No newline at end of file diff --git a/data/Printexc.json b/data/Printexc.json deleted file mode 100644 index 69a29f4..0000000 --- a/data/Printexc.json +++ /dev/null @@ -1,98 +0,0 @@ -{ "module": - { "name": "Printexc", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|0" }, - "info": - { "description": "Facilities for printing exceptions." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Printexc.to_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|995" }, - "info": - { "description": "Printexc.to_string e returns a string representation of the exception e." }, - "type": "exn -> string", - "params": [ - { "name": "", - "type": "exn" } ] } }, - { "value": - { "name": "Printexc.print", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|1112" }, - "info": - { "description": "Printexc.print fn x applies fn to x and returns the result. If the evaluation of fn x raises any exception, the name of the exception is printed on standard error output, and the exception is raised again. The typical use is to catch and report exceptions that escape a function application." }, - "type": "('a -> 'b) -> 'a -> 'b", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Printexc.catch", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|1469" }, - "info": - { "description": "Printexc.catch fn x is similar to Printexc.print, but aborts the program with exit code 2 after printing the uncaught exception. This function is deprecated: the runtime system is now able to print uncaught exceptions as precisely as Printexc.catch does. Moreover, calling Printexc.catch makes it harder to track the location of the exception using the debugger or the stack backtrace facility. So, do not use Printexc.catch in new code." }, - "type": "('a -> 'b) -> 'a -> 'b", - "params": [ - { "name": "", - "type": "'a -> 'b" }, - { "name": "", - "type": "'a" } ] } }, - { "value": - { "name": "Printexc.get_backtrace", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|1984" }, - "info": - { "description": "Printexc.get_backtrace () returns a string containing the same exception backtrace that Printexc.print_backtrace would print.", - "since": "3.11.0" }, - "type": "unit -> string", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Printexc.record_backtrace", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|2182" }, - "info": - { "description": "Printexc.record_backtrace b turns recording of exception backtraces on (if b = true) or off (if b = false). Initially, backtraces are not recorded, unless the b flag is given to the program through the OCAMLRUNPARAM variable.", - "since": "3.11.0" }, - "type": "bool -> unit", - "params": [ - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Printexc.backtrace_status", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|2492" }, - "info": - { "description": "Printexc.backtrace_status() returns true if exception backtraces are currently recorded, false if not.", - "since": "3.11.0" }, - "type": "unit -> bool", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Printexc.register_printer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printexc.mli|2666" }, - "info": - { "description": "Printexc.register_printer fn registers fn as an exception printer. The printer should return None or raise an exception if it does not know how to convert the passed exception, and Some s with s the resulting string if it can convert the passed exception. Exceptions raised by the printer are ignored.

When converting an exception into a string, the printers will be invoked in the reverse order of their registrations, until a printer returns a Some s value (if no such printer exists, the runtime will use a generic printer).", - "since": "3.11.2" }, - "type": "(exn -> string option) -> unit", - "params": [ - { "name": "", - "type": "exn -> string option" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Printf.json b/data/Printf.json deleted file mode 100644 index f4f5571..0000000 --- a/data/Printf.json +++ /dev/null @@ -1,147 +0,0 @@ -{ "module": - { "name": "Printf", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|0" }, - "info": - { "description": "Formatted output functions." }, - "type": "sig end", - "module_structure": [ - { "comment": "Formatted output functions." }, - { "value": - { "name": "Printf.fprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|1001" }, - "info": - { "description": "fprintf outchan format arg1 ... argN formats the arguments arg1 to argN according to the format string format, and outputs the resulting string on the channel outchan.

The format is a character string which contains two types of objects: plain characters, which are simply copied to the output channel, and conversion specifications, each of which causes conversion and printing of arguments.

Conversion specifications have the following form:

% [flags] [width] [.precision] type

In short, a conversion specification consists in the % character, followed by optional modifiers and a type which is made of one or two characters. The types and their meanings are:

The optional flags are: The optional width is an integer indicating the minimal width of the result. For instance, %6d prints an integer, prefixing it with spaces to fill at least 6 characters.

The optional precision is a dot . followed by an integer indicating how many digits follow the decimal point in the %f, %e, and %E conversions. For instance, %.4f prints a float with 4 fractional digits.

The integer in a width or precision can also be specified as , in which case an extra integer argument is taken to specify the corresponding width or precision. This integer argument precedes immediately the argument to print. For instance, %.*f prints a float with as many fractional digits as the value of the argument given before the float." }, - "type": "Pervasives.out_channel ->\n ('a, Pervasives.out_channel, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "('a, Pervasives.out_channel, unit) Pervasives.format" } ] } }, - { "value": - { "name": "Printf.printf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|5625" }, - "info": - { "description": "Same as Printf.fprintf, but output on stdout." }, - "type": "('a, Pervasives.out_channel, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "('a, Pervasives.out_channel, unit) Pervasives.format" } ] } }, - { "value": - { "name": "Printf.eprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|5734" }, - "info": - { "description": "Same as Printf.fprintf, but output on stderr." }, - "type": "('a, Pervasives.out_channel, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "('a, Pervasives.out_channel, unit) Pervasives.format" } ] } }, - { "value": - { "name": "Printf.ifprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|5844" }, - "info": - { "description": "Same as Printf.fprintf, but does not print anything. Useful to ignore some material when conditionally printing.", - "since": "3.10.0" }, - "type": "'a -> ('b, 'a, unit) Pervasives.format -> 'b", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "('a, 'b, unit) Pervasives.format" } ] } }, - { "value": - { "name": "Printf.sprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|6039" }, - "info": - { "description": "Same as Printf.fprintf, but instead of printing on an output channel, return a string containing the result of formatting the arguments." }, - "type": "('a, unit, string) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "('a, unit, string) Pervasives.format" } ] } }, - { "value": - { "name": "Printf.bprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|6236" }, - "info": - { "description": "Same as Printf.fprintf, but instead of printing on an output channel, append the formatted arguments to the given extensible buffer (see module Buffer)." }, - "type": "Buffer.t -> ('a, Buffer.t, unit) Pervasives.format -> 'a", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "('a, Buffer.t, unit) Pervasives.format" } ] } }, - { "comment": "Formatted output functions with continuations." }, - { "value": - { "name": "Printf.kfprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|6524" }, - "info": - { "description": "Same as fprintf, but instead of returning immediately, passes the out channel to its first argument at the end of printing.", - "since": "3.09.0" }, - "type": "(Pervasives.out_channel -> 'a) ->\n Pervasives.out_channel ->\n ('b, Pervasives.out_channel, unit, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "Pervasives.out_channel -> 'a" }, - { "name": "", - "type": "Pervasives.out_channel" }, - { "name": "", - "type": "('a, Pervasives.out_channel, unit, 'b) Pervasives.format4" } ] } }, - { "value": - { "name": "Printf.ksprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|6789" }, - "info": - { "description": "Same as sprintf above, but instead of returning the string, passes it to the first argument.", - "since": "3.09.0" }, - "type": "(string -> 'a) -> ('b, unit, string, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "string -> 'a" }, - { "name": "", - "type": "('a, unit, string, 'b) Pervasives.format4" } ] } }, - { "value": - { "name": "Printf.kbprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|6984" }, - "info": - { "description": "Same as bprintf, but instead of returning immediately, passes the buffer to its first argument at the end of printing.", - "since": "3.10.0" }, - "type": "(Buffer.t -> 'a) ->\n Buffer.t -> ('b, Buffer.t, unit, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "Buffer.t -> 'a" }, - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "('a, Buffer.t, unit, 'b) Pervasives.format4" } ] } }, - { "value": - { "name": "Printf.kprintf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/printf.mli|7235" }, - "info": - { "description": "A deprecated synonym for ksprintf." }, - "type": "(string -> 'a) -> ('b, unit, string, 'a) Pervasives.format4 -> 'b", - "params": [ - { "name": "", - "type": "string -> 'a" }, - { "name": "", - "type": "('a, unit, string, 'b) Pervasives.format4" } ] } } ], - "dependencies": - { "uses": [ "Pervasives", "Obj", "Buffer" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Queue.json b/data/Queue.json deleted file mode 100644 index af526d5..0000000 --- a/data/Queue.json +++ /dev/null @@ -1,199 +0,0 @@ -{ "module": - { "name": "Queue", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|0" }, - "info": - { "description": "First-in first-out queues.

This module implements queues (FIFOs), with in-place modification." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Queue.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1056" }, - "info": - { "description": "The type of queues containing elements of type 'a." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "exception": - { "name": "Queue.Empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1124" }, - "info": - { "description": "Raised when Queue.take or Queue.peek is applied to an empty queue." } } }, - { "value": - { "name": "Queue.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1222" }, - "info": - { "description": "Return a new queue, initially empty." }, - "type": "unit -> 'a Queue.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Queue.add", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1293" }, - "info": - { "description": "add x q adds the element x at the end of the queue q." }, - "type": "'a -> 'a Queue.t -> unit", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.push", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1390" }, - "info": - { "description": "push is a synonym for add." }, - "type": "'a -> 'a Queue.t -> unit", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.take", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1459" }, - "info": - { "description": "take q removes and returns the first element in queue q, or raises Empty if the queue is empty." }, - "type": "'a Queue.t -> 'a", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.pop", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1594" }, - "info": - { "description": "pop is a synonym for take." }, - "type": "'a Queue.t -> 'a", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.peek", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1654" }, - "info": - { "description": "peek q returns the first element in queue q, without removing it from the queue, or raises Empty if the queue is empty." }, - "type": "'a Queue.t -> 'a", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.top", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1813" }, - "info": - { "description": "top is a synonym for peek." }, - "type": "'a Queue.t -> 'a", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.clear", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1873" }, - "info": - { "description": "Discard all elements from a queue." }, - "type": "'a Queue.t -> unit", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|1941" }, - "info": - { "description": "Return a copy of the given queue." }, - "type": "'a Queue.t -> 'a Queue.t", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.is_empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|2007" }, - "info": - { "description": "Return true if the given queue is empty, false otherwise." }, - "type": "'a Queue.t -> bool", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|2105" }, - "info": - { "description": "Return the number of elements in a queue." }, - "type": "'a Queue.t -> int", - "params": [ - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|2180" }, - "info": - { "description": "iter f q applies f in turn to all elements of q, from the least recently entered to the most recently entered. The queue itself is unchanged." }, - "type": "('a -> unit) -> 'a Queue.t -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.fold", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|2382" }, - "info": - { "description": "fold f accu q is equivalent to List.fold_left f accu l, where l is the list of q's elements. The queue remains unchanged." }, - "type": "('a -> 'b -> 'a) -> 'a -> 'b Queue.t -> 'a", - "params": [ - { "name": "", - "type": "'a -> 'b -> 'a" }, - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a Queue.t" } ] } }, - { "value": - { "name": "Queue.transfer", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/queue.mli|2574" }, - "info": - { "description": "transfer q1 q2 adds all of q1's elements at the end of the queue q2, then clears q1. It is equivalent to the sequence iter (fun x -> add x q2) q1; clear q1, but runs in constant time." }, - "type": "'a Queue.t -> 'a Queue.t -> unit", - "params": [ - { "name": "", - "type": "'a Queue.t" }, - { "name": "", - "type": "'a Queue.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Random.json b/data/Random.json deleted file mode 100644 index 909cbc9..0000000 --- a/data/Random.json +++ /dev/null @@ -1,283 +0,0 @@ -{ "module": - { "name": "Random", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|0" }, - "info": - { "description": "Pseudo-random number generators (PRNG)." }, - "type": "sig end", - "module_structure": [ - { "comment": "
Basic functions
" }, - { "value": - { "name": "Random.init", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|1025" }, - "info": - { "description": "Initialize the generator, using the argument as a seed. The same seed will always yield the same sequence of numbers." }, - "type": "int -> unit", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Random.full_init", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|1179" }, - "info": - { "description": "Same as Random.init but takes more data as seed." }, - "type": "int array -> unit", - "params": [ - { "name": "", - "type": "int array" } ] } }, - { "value": - { "name": "Random.self_init", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|1273" }, - "info": - { "description": "Initialize the generator with a more-or-less random seed chosen in a system-dependent way." }, - "type": "unit -> unit", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Random.bits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|1404" }, - "info": - { "description": "Return 30 random bits in a nonnegative integer." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Random.int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|1586" }, - "info": - { "description": "Random.int bound returns a random integer between 0 (inclusive) and bound (exclusive). bound must be greater than 0 and less than 230." }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Random.int32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|1770" }, - "info": - { "description": "Random.int32 bound returns a random integer between 0 (inclusive) and bound (exclusive). bound must be greater than 0." }, - "type": "Int32.t -> Int32.t", - "params": [ - { "name": "", - "type": "Int32.t" } ] } }, - { "value": - { "name": "Random.nativeint", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|1942" }, - "info": - { "description": "Random.nativeint bound returns a random integer between 0 (inclusive) and bound (exclusive). bound must be greater than 0." }, - "type": "Nativeint.t -> Nativeint.t", - "params": [ - { "name": "", - "type": "Nativeint.t" } ] } }, - { "value": - { "name": "Random.int64", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|2130" }, - "info": - { "description": "Random.int64 bound returns a random integer between 0 (inclusive) and bound (exclusive). bound must be greater than 0." }, - "type": "Int64.t -> Int64.t", - "params": [ - { "name": "", - "type": "Int64.t" } ] } }, - { "value": - { "name": "Random.float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|2302" }, - "info": - { "description": "Random.float bound returns a random floating-point number between 0 (inclusive) and bound (exclusive). If bound is negative, the result is negative or zero. If bound is 0, the result is 0." }, - "type": "float -> float", - "params": [ - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Random.bool", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|2545" }, - "info": - { "description": "Random.bool () returns true or false with probability 0.5 each." }, - "type": "unit -> bool", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "comment": "
Advanced functions
" }, - { "comment": "The functions from module State manipulate the current state of the random generator explicitely. This allows using one or several deterministic PRNGs, even in a multi-threaded program, without interference from other parts of the program." }, - { "module": - { "name": "Random.State", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|2945" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Random.State.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|2971" }, - "info": - { "description": "The type of PRNG states." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Random.State.make", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3010" }, - "info": - { "description": "Create a new state and initialize it with the given seed." }, - "type": "int array -> Random.State.t", - "params": [ - { "name": "", - "type": "int array" } ] } }, - { "value": - { "name": "Random.State.make_self_init", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3106" }, - "info": - { "description": "Create a new state and initialize it with a system-dependent low-entropy seed." }, - "type": "unit -> Random.State.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Random.State.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3234" }, - "info": - { "description": "Return a copy of the given state." }, - "type": "Random.State.t -> Random.State.t", - "params": [ - { "name": "", - "type": "Random.State.t" } ] } }, - { "value": - { "name": "Random.State.bits", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3298" }, - "info": "", - "type": "Random.State.t -> int", - "params": [ - { "name": "", - "type": "Random.State.t" } ] } }, - { "value": - { "name": "Random.State.int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3320" }, - "info": "", - "type": "Random.State.t -> int -> int", - "params": [ - { "name": "", - "type": "Random.State.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Random.State.int32", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3348" }, - "info": "", - "type": "Random.State.t -> Int32.t -> Int32.t", - "params": [ - { "name": "", - "type": "Random.State.t" }, - { "name": "", - "type": "Int32.t" } ] } }, - { "value": - { "name": "Random.State.nativeint", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3386" }, - "info": "", - "type": "Random.State.t -> Nativeint.t -> Nativeint.t", - "params": [ - { "name": "", - "type": "Random.State.t" }, - { "name": "", - "type": "Nativeint.t" } ] } }, - { "value": - { "name": "Random.State.int64", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3436" }, - "info": "", - "type": "Random.State.t -> Int64.t -> Int64.t", - "params": [ - { "name": "", - "type": "Random.State.t" }, - { "name": "", - "type": "Int64.t" } ] } }, - { "value": - { "name": "Random.State.float", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3474" }, - "info": "", - "type": "Random.State.t -> float -> float", - "params": [ - { "name": "", - "type": "Random.State.t" }, - { "name": "", - "type": "float" } ] } }, - { "value": - { "name": "Random.State.bool", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3508" }, - "info": - { "description": "These functions are the same as the basic functions, except that they use (and update) the given PRNG state instead of the default one." }, - "type": "Random.State.t -> bool", - "params": [ - { "name": "", - "type": "Random.State.t" } ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "value": - { "name": "Random.get_state", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3690" }, - "info": - { "description": "Return the current state of the generator used by the basic functions." }, - "type": "unit -> Random.State.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Random.set_state", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/random.mli|3801" }, - "info": - { "description": "Set the state of the generator used by the basic functions." }, - "type": "Random.State.t -> unit", - "params": [ - { "name": "", - "type": "Random.State.t" } ] } } ], - "dependencies": - { "uses": [ "Nativeint", "Int64", "Int32" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Regexp.json b/data/Regexp.json deleted file mode 100644 index bd91c38..0000000 --- a/data/Regexp.json +++ /dev/null @@ -1,284 +0,0 @@ -{ "module": - { "name": "Regexp", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|0" }, - "info": - { "description": "This module can be safely open for it only contains a module Re." }, - "type": "sig end", - "module_structure": [ - { "module": - { "name": "Regexp.Re", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|73" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "comment": "This module provides functions for creating and using Regular Expression.

It is in pure OCaml (unlike Pcre_Ocaml) and thus more portable. It is reentrant (unlike Str) but not thread-safe in case of preemptive schedulling." }, - { "comment": "# Basic regexps." }, - { "type": - { "name": "Regexp.Re.regexp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|387" }, - "info": - { "description": "The type of regexps." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "comment": "## Regexp constructors." }, - { "comment": "### Functional constructors." }, - { "value": - { "name": "Regexp.Re.empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|510" }, - "info": - { "description": "The regexp denoting the absence of word." }, - "type": "Regexp.Re.regexp", - "params": [ ] } }, - { "value": - { "name": "Regexp.Re.epsilon", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|572" }, - "info": - { "description": "The regexp denoting the empty word." }, - "type": "Regexp.Re.regexp", - "params": [ ] } }, - { "value": - { "name": "Regexp.Re.char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|639" }, - "info": - { "description": "The regexp matching a given character." }, - "type": "char -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Regexp.Re.char_interv", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|747" }, - "info": - { "description": "The regexp matching any character in the given range. Bounds are included." }, - "type": "char -> char -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "char" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Regexp.Re.string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|839" }, - "info": - { "description": "The regexp matching the exact given string." }, - "type": "string -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Regexp.Re.star", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|945" }, - "info": - { "description": "The regexp matching 0 or more words recognized by the given regexp." }, - "type": "Regexp.Re.regexp -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "Regexp.Re.regexp" } ] } }, - { "value": - { "name": "Regexp.Re.alt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|1050" }, - "info": - { "description": "The regexp matching words matched by either one of the given regexps." }, - "type": "Regexp.Re.regexp -> Regexp.Re.regexp -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "Regexp.Re.regexp" }, - { "name": "", - "type": "Regexp.Re.regexp" } ] } }, - { "value": - { "name": "Regexp.Re.seq", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|1191" }, - "info": - { "description": "The regexp matching the concatenation of two words matched by each one of the given regexps." }, - "type": "Regexp.Re.regexp -> Regexp.Re.regexp -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "Regexp.Re.regexp" }, - { "name": "", - "type": "Regexp.Re.regexp" } ] } }, - { "value": - { "name": "Regexp.Re.opt", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|1296" }, - "info": - { "description": "The regexp matching 0 or 1 word matched by the given regexp." }, - "type": "Regexp.Re.regexp -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "Regexp.Re.regexp" } ] } }, - { "value": - { "name": "Regexp.Re.some", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|1395" }, - "info": - { "description": "The regexp matching 1 or more words matched by the given regexp." }, - "type": "Regexp.Re.regexp -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "Regexp.Re.regexp" } ] } }, - { "comment": "### Parsing constructor." }, - { "value": - { "name": "Regexp.Re.from_string_raw", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|1620" }, - "info": - { "description": "from_string_raw s parses the string s and returns the associated regexp.

The following constructions can be used in the given string: TODO" }, - "type": "string -> Regexp.Re.regexp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "comment": "# Regexp compilation." }, - { "comment": "In order to improve the efficiency of regexps, they are compiled to a different internal representation." }, - { "type": - { "name": "Regexp.Re.compiled_regexp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|1849" }, - "info": - { "description": "The type of compiled regexps." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "comment": "## Constructors for compiled regexps." }, - { "value": - { "name": "Regexp.Re.compile", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|1958" }, - "info": - { "description": "compile re compiles the regexp re." }, - "type": "Regexp.Re.regexp -> Regexp.Re.compiled_regexp", - "params": [ - { "name": "", - "type": "Regexp.Re.regexp" } ] } }, - { "value": - { "name": "Regexp.Re.from_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|2055" }, - "info": - { "description": "from_string s is compile (from_string_raw s)." }, - "type": "string -> Regexp.Re.compiled_regexp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "comment": "# Regexp usage." }, - { "value": - { "name": "Regexp.Re.search_forward", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|2439" }, - "info": - { "description": "search_forward cre s i evaluates either to Some (b, e) is String.sub s b (e - b) is matched by cre (with b >= i or None if no such tuple exists. In other words, (e, b) are the inclusive begining and exclusive ending offset of a word of s starting from i matched by cre." }, - "type": "Regexp.Re.compiled_regexp -> string -> int -> (int * int) option", - "params": [ - { "name": "", - "type": "Regexp.Re.compiled_regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Regexp.Re.match_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|2659" }, - "info": - { "description": "match_string cre s i evaluates to either Some e if String.sub s i (e - i) is matched by cre or None if no such e exists." }, - "type": "Regexp.Re.compiled_regexp -> string -> int -> int option", - "params": [ - { "name": "", - "type": "Regexp.Re.compiled_regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Regexp.Re.list_matches", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|2924" }, - "info": - { "description": "list_matches cre s evaluates to a list of strings in which each element is a sub-string of s matched by cre. None of the sub-string overlap. Moreover, they are of maximal size." }, - "type": "Regexp.Re.compiled_regexp -> string -> string list", - "params": [ - { "name": "", - "type": "Regexp.Re.compiled_regexp" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Regexp.Re.split_delim", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|3217" }, - "info": - { "description": "split_delim cre s evaluates to a list of string in which each element is a sub-string of the original one. Each two consecutive elements of the list of sub-string was, in s separated by a word matched by cre." }, - "type": "Regexp.Re.compiled_regexp -> string -> string list", - "params": [ - { "name": "", - "type": "Regexp.Re.compiled_regexp" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Regexp.Re.replace", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|3356" }, - "info": - { "description": "replace cre s by replaces sub-strings of s matched by cre by by." }, - "type": "Regexp.Re.compiled_regexp -> string -> string -> string", - "params": [ - { "name": "", - "type": "Regexp.Re.compiled_regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Regexp.Re.substitute", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/regexp.mli|3541" }, - "info": - { "description": "substitute cre s map substitutes sub-strings of s matched by cre by map w where w is the matched word." }, - "type": "Regexp.Re.compiled_regexp -> string -> (string -> string) -> string", - "params": [ - { "name": "", - "type": "Regexp.Re.compiled_regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "string -> string" } ] } } ], - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Scanf.json b/data/Scanf.json deleted file mode 100644 index e261159..0000000 --- a/data/Scanf.json +++ /dev/null @@ -1,343 +0,0 @@ -{ "module": - { "name": "Scanf", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|0" }, - "info": - { "description": "Formatted input functions." }, - "type": "sig end", - "module_structure": [ - { "comment": "
Introduction
" }, - { "comment": "Functional input with format strings" }, - { "comment": "The module Scanf provides formatted input functions or scanners.

The formatted input functions can read from any kind of input, including strings, files, or anything that can return characters. The more general source of characters is named a formatted input channel (or scanning buffer) and has type Scanf.Scanning.in_channel. The more general formatted input function reads from any scanning buffer and is named bscanf.

Generally speaking, the formatted input functions have 3 arguments: Hence, a typical call to the formatted input function Scanf.bscanf is bscanf ic fmt f, where:

" }, - { "comment": "A simple example" }, - { "comment": "As suggested above, the expression bscanf ic \"%d\" f reads a decimal integer n from the source of characters ic and returns f n.

For instance,

then bscanf Scanning.stdin \"%d\" f reads an integer n from the standard input and returns f n (that is n + 1). Thus, if we evaluate bscanf stdin \"%d\" f, and then enter 41 at the keyboard, we get 42 as the final result." }, - { "comment": "Formatted input as a functional feature" }, - { "comment": "The Caml scanning facility is reminiscent of the corresponding C feature. However, it is also largely different, simpler, and yet more powerful: the formatted input functions are higher-order functionals and the parameter passing mechanism is just the regular function application not the variable assignment based mechanism which is typical for formatted input in imperative languages; the Caml format strings also feature useful additions to easily define complex tokens; as expected within a functional programming language, the formatted input functions also support polymorphism, in particular arbitrary interaction with polymorphic user-defined scanners. Furthermore, the Caml formatted input facility is fully type-checked at compile time." }, - { "module": - { "name": "Scanf.Scanning", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|3836" }, - "info": - { "description": "
Formatted input channel
" }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Scanf.Scanning.in_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|3864" }, - "info": "", - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "type": - { "name": "Scanf.Scanning.scanbuf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|4251" }, - "info": - { "description": "The type of scanning buffers. A scanning buffer is the source from which a formatted input function gets characters. The scanning buffer holds the current state of the scan, plus a function to get the next char from the input, and a token buffer to store the string matched so far.

Note: a scanning action may often require to examine one character in advance; when this ``lookahead'' character does not belong to the token read, it is stored back in the scanning buffer and becomes the next character read." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "Scanf.Scanning.in_channel" } }, - { "value": - { "name": "Scanf.Scanning.stdin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|4819" }, - "info": - { "description": "The standard input notion for the module Scanf. stdin is equivalent to Scanning.from_channel Pervasives.stdin.

Note: when input is read interactively from stdin, the newline character that triggers the evaluation is incorporated in the input; thus, scanning specifications must properly skip this character (simply add a '\\n' as the last character of the format string).", - "since": "3.12.0" }, - "type": "Scanf.Scanning.in_channel", - "params": [ ] } }, - { "value": - { "name": "Scanf.Scanning.open_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|5272" }, - "info": - { "description": "Bufferized file reading in text mode. The efficient and usual way to scan text mode files (in effect, from_file returns a scanning buffer that reads characters in large chunks, rather than one character at a time as buffers returned by from_channel below do). Scanning.from_file fname returns a scanning buffer which reads from the given file fname in text mode.", - "since": "3.12.0" }, - "type": "string -> Scanf.Scanning.in_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Scanf.Scanning.open_in_bin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|5726" }, - "info": - { "description": "Bufferized file reading in binary mode.", - "since": "3.12.0" }, - "type": "string -> Scanf.Scanning.in_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Scanf.Scanning.close_in", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|5829" }, - "info": - { "description": "Close the Pervasives.input_channel associated with the given Scanning.in_channel.", - "since": "3.12.0" }, - "type": "Scanf.Scanning.in_channel -> unit", - "params": [ - { "name": "", - "type": "Scanf.Scanning.in_channel" } ] } }, - { "value": - { "name": "Scanf.Scanning.from_file", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|5977" }, - "info": - { "description": "An alias for open_in above." }, - "type": "string -> Scanf.Scanning.in_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Scanf.Scanning.from_file_bin", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|6053" }, - "info": - { "description": "An alias for open_in_bin above." }, - "type": "string -> Scanf.Scanning.in_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Scanf.Scanning.from_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|6138" }, - "info": - { "description": "Scanning.from_string s returns a formatted input channel which reads from the given string. Reading starts from the first character in the string. The end-of-input condition is set when the end of the string is reached." }, - "type": "string -> Scanf.Scanning.in_channel", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Scanf.Scanning.from_function", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|6421" }, - "info": - { "description": "Scanning.from_function f returns a scanning buffer with the given function as its reading method.

When scanning needs one more character, the given function is called.

When the function has no more character to provide, it must signal an end-of-input condition by raising the exception End_of_file." }, - "type": "(unit -> char) -> Scanf.Scanning.in_channel", - "params": [ - { "name": "", - "type": "unit -> char" } ] } }, - { "value": - { "name": "Scanf.Scanning.from_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|6805" }, - "info": - { "description": "Scanning.from_channel ic returns a formatted input channel which reads from the regular input channel ic argument, starting at the current reading position." }, - "type": "Pervasives.in_channel -> Scanf.Scanning.in_channel", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Scanf.Scanning.end_of_input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|7039" }, - "info": - { "description": "Scanning.end_of_input ic tests the end-of-input condition of the given formatted input channel." }, - "type": "Scanf.Scanning.in_channel -> bool", - "params": [ - { "name": "", - "type": "Scanf.Scanning.in_channel" } ] } }, - { "value": - { "name": "Scanf.Scanning.beginning_of_input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|7189" }, - "info": - { "description": "Scanning.beginning_of_input ic tests the beginning of input condition of the given formatted input channel." }, - "type": "Scanf.Scanning.in_channel -> bool", - "params": [ - { "name": "", - "type": "Scanf.Scanning.in_channel" } ] } }, - { "value": - { "name": "Scanf.Scanning.name_of_input", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|7357" }, - "info": - { "description": "Scanning.file_name_of_input ic returns the name of the character source for the formatted input channel ic.", - "since": "3.09.0" }, - "type": "Scanf.Scanning.in_channel -> string", - "params": [ - { "name": "", - "type": "Scanf.Scanning.in_channel" } ] } }, - { "value": - { "name": "Scanf.Scanning.stdib", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|7542" }, - "info": - { "description": "A deprecated alias for Scanning.stdin, the scanning buffer reading from Pervasives.stdin." }, - "type": "Scanf.Scanning.in_channel", - "params": [ ] } } ], - "dependencies": - { "uses": [ ] } } }, - { "comment": "
Type of formatted input functions
" }, - { "type": - { "name": "Scanf.scanner", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|7731" }, - "info": - { "description": "The type of formatted input scanners: ('a, 'b, 'c, 'd) scanner is the type of a formatted input function that reads from some formatted input channel according to some format string; more precisely, if scan is some formatted input function, then scan ic fmt f applies f to the arguments specified by the format string fmt, when scan has read those arguments from the formatted input channel ic.

For instance, the scanf function below has type ('a, 'b, 'c, 'd) scanner, since it is a formatted input function that reads from Scanning.stdin: scanf fmt f applies f to the arguments specified by fmt, reading those arguments from Pervasives.stdin as expected.

If the format fmt has some %r indications, the corresponding input functions must be provided before the receiver f argument. For instance, if read_elem is an input function for values of type t, then bscanf ic \"%r;\" read_elem f reads a value v of type t followed by a ';' character, and returns f v.", - "since": "3.10.0" }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" }, - { "covariant": "true", - "contravariant": "true", - "type": "'b" }, - { "covariant": "true", - "contravariant": "true", - "type": "'c" }, - { "covariant": "true", - "contravariant": "true", - "type": "'d" } ], - "kind": - { "type": "abstract" }, - "manifest": "('a, Scanf.Scanning.in_channel, 'b, 'c, 'a -> 'd, 'd) format6 -> 'c" } }, - { "exception": - { "name": "Scanf.Scan_failure", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|8916" }, - "info": - { "description": "The exception that formatted input functions raise when the input cannot be read according to the given format." }, - "exception_args": [ "string" ] } }, - { "comment": "
The general formatted input function
" }, - { "value": - { "name": "Scanf.bscanf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|9124" }, - "info": - { "description": "bscanf ic fmt r1 ... rN f reads arguments for the function f, from the formatted input channel ic, according to the format string fmt, and applies f to these values. The result of this call to f is returned as the result of the entire bscanf call. For instance, if f is the function fun s i -> i + 1, then Scanf.sscanf \"x= 1\" \"%s = %i\" f returns 2.

Arguments r1 to rN are user-defined input functions that read the argument corresponding to a %r conversion." }, - "type": "Scanf.Scanning.in_channel -> ('a, 'b, 'c, 'd) Scanf.scanner", - "params": [ - { "name": "", - "type": "Scanf.Scanning.in_channel" } ] } }, - { "comment": "
Format string description
" }, - { "comment": "The format is a character string which contains three types of objects:" }, - { "comment": "The space character in format strings" }, - { "comment": "As mentioned above, a plain character in the format string is just matched with the next character of the input; however, two characters are special exceptions to this rule: the space character (' ' or ASCII code 32) and the line feed character ('\\n' or ASCII code 10). A space does not match a single space character, but any amount of ``whitespace'' in the input. More precisely, a space inside the format string matches any number of tab, space, line feed and carriage return characters. Similarly, a line feed character in the format string matches either a single line feed or a carriage return followed by a line feed.

Matching any amount of whitespace, a space in the format string also matches no amount of whitespace at all; hence, the call bscanf ib \"Price = %d $\" (fun p -> p) succeeds and returns 1 when reading an input with various whitespace in it, such as Price = 1 $, Price = 1 $, or even Price=1$." }, - { "comment": "Conversion specifications in format strings" }, - { "comment": "Conversion specifications consist in the % character, followed by an optional flag, an optional field width, and followed by one or two conversion characters. The conversion characters and their meanings are:

Following the % character that introduces a conversion, there may be the special flag _: the conversion that follows occurs as usual, but the resulting value is discarded. For instance, if f is the function fun i -> i + 1, then Scanf.sscanf \"x = 1\" \"%_s = %i\" f returns 2.

The field width is composed of an optional integer literal indicating the maximal width of the token to read. For instance, %6d reads an integer, having at most 6 decimal digits; %4f reads a float with at most 4 characters; and %8[\\\\000-\\\\255] returns the next 8 characters (or all the characters still available, if fewer than 8 characters are available in the input).

Notes:

" }, - { "comment": "Scanning indications in format strings" }, - { "comment": "Scanning indications appear just after the string conversions %s and %[ range ] to delimit the end of the token. A scanning indication is introduced by a @ character, followed by some constant character c. It means that the string token should end just before the next matching c (which is skipped). If no c character is encountered, the string token spreads as much as possible. For instance, \"%s@\\t\" reads a string up to the next tab character or to the end of input. If a scanning indication @c does not follow a string conversion, it is treated as a plain c character.

Note:

" }, - { "comment": "Exceptions during scanning" }, - { "comment": "Scanners may raise the following exceptions when the input cannot be read according to the format string:

Note:

" }, - { "comment": "
Specialised formatted input functions
" }, - { "value": - { "name": "Scanf.fscanf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|20060" }, - "info": - { "description": "Same as Scanf.bscanf, but reads from the given regular input channel.

Warning: since all formatted input functions operate from a formatted input channel, be aware that each fscanf invocation will operate with a formatted input channel reading from the given channel. This extra level of bufferization can lead to strange scanning behaviour if you use low level primitives on the channel (reading characters, seeking the reading position, and so on).

As a consequence, never mix direct low level reading and high level scanning from the same regular input channel." }, - "type": "Pervasives.in_channel -> ('a, 'b, 'c, 'd) Scanf.scanner", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Scanf.sscanf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|20741" }, - "info": - { "description": "Same as Scanf.bscanf, but reads from the given string." }, - "type": "string -> ('a, 'b, 'c, 'd) Scanf.scanner", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Scanf.scanf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|20857" }, - "info": - { "description": "Same as Scanf.bscanf, but reads from the predefined formatted input channel Scanf.Scanning.stdin that is connected to Pervasives.stdin." }, - "type": "('a, 'b, 'c, 'd) Scanf.scanner", - "params": [ ] } }, - { "value": - { "name": "Scanf.kscanf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|21052" }, - "info": - { "description": "Same as Scanf.bscanf, but takes an additional function argument ef that is called in case of error: if the scanning process or some conversion fails, the scanning function aborts and calls the error handling function ef with the scanning buffer and the exception that aborted the scanning process as arguments." }, - "type": "Scanf.Scanning.in_channel ->\n (Scanf.Scanning.in_channel -> exn -> 'a) -> ('b, 'c, 'd, 'a) Scanf.scanner", - "params": [ - { "name": "", - "type": "Scanf.Scanning.in_channel" }, - { "name": "", - "type": "Scanf.Scanning.in_channel -> exn -> 'a" } ] } }, - { "comment": "
Reading format strings from input
" }, - { "value": - { "name": "Scanf.bscanf_format", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|21547" }, - "info": - { "description": "bscanf_format ic fmt f reads a format string token from the formatted input channel ic, according to the given format string fmt, and applies f to the resulting format string value. Raise Scan_failure if the format string value read does not have the same type as fmt.", - "since": "3.09.0" }, - "type": "Scanf.Scanning.in_channel ->\n ('a, 'b, 'c, 'd, 'e, 'f) format6 ->\n (('a, 'b, 'c, 'd, 'e, 'f) format6 -> 'g) -> 'g", - "params": [ - { "name": "", - "type": "Scanf.Scanning.in_channel" }, - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6" }, - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6 -> 'g" } ] } }, - { "value": - { "name": "Scanf.sscanf_format", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|22004" }, - "info": - { "description": "Same as Scanf.bscanf_format, but reads from the given string.", - "since": "3.09.0" }, - "type": "string ->\n ('a, 'b, 'c, 'd, 'e, 'f) format6 ->\n (('a, 'b, 'c, 'd, 'e, 'f) format6 -> 'g) -> 'g", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6" }, - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6 -> 'g" } ] } }, - { "value": - { "name": "Scanf.format_from_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/scanf.mli|22216" }, - "info": - { "description": "format_from_string s fmt converts a string argument to a format string, according to the given format string fmt. Raise Scan_failure if s, considered as a format string, does not have the same type as fmt.", - "since": "3.10.0" }, - "type": "string ->\n ('a, 'b, 'c, 'd, 'e, 'f) format6 -> ('a, 'b, 'c, 'd, 'e, 'f) format6", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "('a, 'b, 'c, 'd, 'e, 'f) format6" } ] } } ], - "dependencies": - { "uses": [ "Pervasives" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Set.json b/data/Set.json deleted file mode 100644 index db1b909..0000000 --- a/data/Set.json +++ /dev/null @@ -1,48 +0,0 @@ -{ "module": - { "name": "Set", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli|0" }, - "info": - { "description": "Sets over ordered types.

This module implements the set data structure, given a total ordering function over the set elements. All operations over sets are purely applicative (no side-effects). The implementation uses balanced binary trees, and is therefore reasonably efficient: insertion and membership take time logarithmic in the size of the set, for instance." }, - "type": "sig end", - "module_structure": [ - { "module_type": - { "name": "Set.OrderedType", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli|1337" }, - "info": - { "description": "Input signature of the functor Set.Make." }, - "type": "sig end", - "kind": "" } }, - { "module_type": - { "name": "Set.S", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli|1973" }, - "info": - { "description": "Output signature of the functor Set.Make." }, - "type": "sig end", - "kind": "" } }, - { "module": - { "name": "Set.Make", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/set.mli|5783" }, - "info": - { "description": "Functor building an implementation of the set structure given a totally ordered type." }, - "type": "functor (Ord : OrderedType) -> sig end", - "module_functor": - { "parameter": - { "name": "Ord" }, - "module_with": "unavailable" }, - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Sort.json b/data/Sort.json deleted file mode 100644 index 4414599..0000000 --- a/data/Sort.json +++ /dev/null @@ -1,55 +0,0 @@ -{ "module": - { "name": "Sort", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sort.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sort.mli|0" }, - "info": - { "description": "Sorting and merging lists.", - "deprecated": "This module is obsolete and exists only for backward compatibility. The sorting functions in Array and List should be used instead. The new functions are faster and use less memory." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "Sort.list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sort.mli|1194" }, - "info": - { "description": "Sort a list in increasing order according to an ordering predicate. The predicate should return true if its first argument is less than or equal to its second argument." }, - "type": "('a -> 'a -> bool) -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> 'a -> bool" }, - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Sort.array", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sort.mli|1431" }, - "info": - { "description": "Sort an array in increasing order according to an ordering predicate. The predicate should return true if its first argument is less than or equal to its second argument. The array is sorted in place." }, - "type": "('a -> 'a -> bool) -> 'a array -> unit", - "params": [ - { "name": "", - "type": "'a -> 'a -> bool" }, - { "name": "", - "type": "'a array" } ] } }, - { "value": - { "name": "Sort.merge", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sort.mli|1705" }, - "info": - { "description": "Merge two lists according to the given predicate. Assuming the two argument lists are sorted according to the predicate, merge returns a sorted list containing the elements from the two lists. The behavior is undefined if the two argument lists were not sorted." }, - "type": "('a -> 'a -> bool) -> 'a list -> 'a list -> 'a list", - "params": [ - { "name": "", - "type": "'a -> 'a -> bool" }, - { "name": "", - "type": "'a list" }, - { "name": "", - "type": "'a list" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Stack.json b/data/Stack.json deleted file mode 100644 index cb92fbe..0000000 --- a/data/Stack.json +++ /dev/null @@ -1,136 +0,0 @@ -{ "module": - { "name": "Stack", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|0" }, - "info": - { "description": "Last-in first-out stacks.

This module implements stacks (LIFOs), with in-place modification." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Stack.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1056" }, - "info": - { "description": "The type of stacks containing elements of type 'a." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'a" } ], - "kind": - { "type": "abstract" } } }, - { "exception": - { "name": "Stack.Empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1123" }, - "info": - { "description": "Raised when Stack.pop or Stack.top is applied to an empty stack." } } }, - { "value": - { "name": "Stack.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1219" }, - "info": - { "description": "Return a new stack, initially empty." }, - "type": "unit -> 'a Stack.t", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Stack.push", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1290" }, - "info": - { "description": "push x s adds the element x at the top of stack s." }, - "type": "'a -> 'a Stack.t -> unit", - "params": [ - { "name": "", - "type": "'a" }, - { "name": "", - "type": "'a Stack.t" } ] } }, - { "value": - { "name": "Stack.pop", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1385" }, - "info": - { "description": "pop s removes and returns the topmost element in stack s, or raises Empty if the stack is empty." }, - "type": "'a Stack.t -> 'a", - "params": [ - { "name": "", - "type": "'a Stack.t" } ] } }, - { "value": - { "name": "Stack.top", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1520" }, - "info": - { "description": "top s returns the topmost element in stack s, or raises Empty if the stack is empty." }, - "type": "'a Stack.t -> 'a", - "params": [ - { "name": "", - "type": "'a Stack.t" } ] } }, - { "value": - { "name": "Stack.clear", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1643" }, - "info": - { "description": "Discard all elements from a stack." }, - "type": "'a Stack.t -> unit", - "params": [ - { "name": "", - "type": "'a Stack.t" } ] } }, - { "value": - { "name": "Stack.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1711" }, - "info": - { "description": "Return a copy of the given stack." }, - "type": "'a Stack.t -> 'a Stack.t", - "params": [ - { "name": "", - "type": "'a Stack.t" } ] } }, - { "value": - { "name": "Stack.is_empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1777" }, - "info": - { "description": "Return true if the given stack is empty, false otherwise." }, - "type": "'a Stack.t -> bool", - "params": [ - { "name": "", - "type": "'a Stack.t" } ] } }, - { "value": - { "name": "Stack.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1875" }, - "info": - { "description": "Return the number of elements in a stack." }, - "type": "'a Stack.t -> int", - "params": [ - { "name": "", - "type": "'a Stack.t" } ] } }, - { "value": - { "name": "Stack.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stack.mli|1950" }, - "info": - { "description": "iter f s applies f in turn to all elements of s, from the element at the top of the stack to the element at the bottom of the stack. The stack itself is unchanged." }, - "type": "('a -> unit) -> 'a Stack.t -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a Stack.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Std_exit.json b/data/Std_exit.json deleted file mode 100644 index 1eaacb7..0000000 --- a/data/Std_exit.json +++ /dev/null @@ -1,12 +0,0 @@ -{ "module": - { "name": "Std_exit", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/std_exit.ml", - "location": - { "implementation": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/std_exit.ml|0", - "interface": "unknown" }, - "info": "", - "type": "sig end", - "module_structure": [ ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Str.json b/data/Str.json deleted file mode 100644 index 97343f7..0000000 --- a/data/Str.json +++ /dev/null @@ -1,445 +0,0 @@ -{ "module": - { "name": "Str", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|0" }, - "info": - { "description": "Regular expressions and high-level string processing" }, - "type": "sig end", - "module_structure": [ - { "comment": "
Regular expressions
" }, - { "type": - { "name": "Str.regexp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|1045" }, - "info": - { "description": "The type of compiled regular expressions." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Str.regexp", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|1103" }, - "info": - { "description": "Compile a regular expression. The following constructs are recognized:" }, - "type": "string -> Str.regexp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.regexp_case_fold", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|2549" }, - "info": - { "description": "Same as regexp, but the compiled expression will match text in a case-insensitive way: uppercase and lowercase letters will be considered equivalent." }, - "type": "string -> Str.regexp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.quote", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|2757" }, - "info": - { "description": "Str.quote s returns a regexp string that matches exactly s and nothing else." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.regexp_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|2878" }, - "info": - { "description": "Str.regexp_string s returns a regular expression that matches exactly s and nothing else." }, - "type": "string -> Str.regexp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.regexp_string_case_fold", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|3019" }, - "info": - { "description": "Str.regexp_string_case_fold is similar to Str.regexp_string, but the regexp matches in a case-insensitive way." }, - "type": "string -> Str.regexp", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "comment": "
String matching and searching
" }, - { "value": - { "name": "Str.string_match", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|3237" }, - "info": - { "description": "string_match r s start tests whether a substring of s that starts at position start matches the regular expression r. The first character of a string has position 0, as usual." }, - "type": "Str.regexp -> string -> int -> bool", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.search_forward", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|3488" }, - "info": - { "description": "search_forward r s start searches the string s for a substring matching the regular expression r. The search starts at position start and proceeds towards the end of the string. Return the position of the first character of the matched substring, or raise Not_found if no substring matches." }, - "type": "Str.regexp -> string -> int -> int", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.search_backward", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|3861" }, - "info": - { "description": "search_backward r s last searches the string s for a substring matching the regular expression r. The search first considers substrings that start at position last and proceeds towards the beginning of string. Return the position of the first character of the matched substring; raise Not_found if no substring matches." }, - "type": "Str.regexp -> string -> int -> int", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.string_partial_match", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|4262" }, - "info": - { "description": "Similar to Str.string_match, but also returns true if the argument string is a prefix of a string that matches. This includes the case of a true complete match." }, - "type": "Str.regexp -> string -> int -> bool", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.matched_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|4499" }, - "info": - { "description": "matched_string s returns the substring of s that was matched by the latest Str.string_match, Str.search_forward or Str.search_backward. The user must make sure that the parameter s is the same string that was passed to the matching or searching function." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.match_beginning", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|4827" }, - "info": - { "description": "match_beginning() returns the position of the first character of the substring that was matched by Str.string_match, Str.search_forward or Str.search_backward." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Str.match_end", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|5046" }, - "info": - { "description": "match_end() returns the position of the character following the last character of the substring that was matched by string_match, search_forward or search_backward." }, - "type": "unit -> int", - "params": [ - { "name": "", - "type": "unit" } ] } }, - { "value": - { "name": "Str.matched_group", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|5261" }, - "info": - { "description": "matched_group n s returns the substring of s that was matched by the nth group \\(...\\) of the regular expression during the latest Str.string_match, Str.search_forward or Str.search_backward. The user must make sure that the parameter s is the same string that was passed to the matching or searching function. matched_group n s raises Not_found if the nth group of the regular expression was not matched. This can happen with groups inside alternatives \\|, options ? or repetitions . For instance, the empty string will match \\(a\\)*, but matched_group 1 \"\" will raise Not_found because the first group itself was not matched." }, - "type": "int -> string -> string", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.group_beginning", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|6013" }, - "info": - { "description": "group_beginning n returns the position of the first character of the substring that was matched by the nth group of the regular expression.", - "raised_exceptions": [ - { "raised_exception": "Not_found", - "text": "if the nth group of the regular expression was not matched." }, - { "raised_exception": "Invalid_argument", - "text": "if there are fewer than n groups in the regular expression." } ] }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.group_end", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|6381" }, - "info": - { "description": "group_end n returns the position of the character following the last character of substring that was matched by the nth group of the regular expression.", - "raised_exceptions": [ - { "raised_exception": "Not_found", - "text": "if the nth group of the regular expression was not matched." }, - { "raised_exception": "Invalid_argument", - "text": "if there are fewer than n groups in the regular expression." } ] }, - "type": "int -> int", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "comment": "
Replacement
" }, - { "value": - { "name": "Str.global_replace", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|6782" }, - "info": - { "description": "global_replace regexp templ s returns a string identical to s, except that all substrings of s that match regexp have been replaced by templ. The replacement template templ can contain \\1, \\2, etc; these sequences will be replaced by the text matched by the corresponding group in the regular expression. \\0 stands for the text matched by the whole regular expression." }, - "type": "Str.regexp -> string -> string -> string", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.replace_first", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|7250" }, - "info": - { "description": "Same as Str.global_replace, except that only the first substring matching the regular expression is replaced." }, - "type": "Str.regexp -> string -> string -> string", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.global_substitute", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|7431" }, - "info": - { "description": "global_substitute regexp subst s returns a string identical to s, except that all substrings of s that match regexp have been replaced by the result of function subst. The function subst is called once for each matching substring, and receives s (the whole text) as argument." }, - "type": "Str.regexp -> (string -> string) -> string -> string", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string -> string" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.substitute_first", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|7814" }, - "info": - { "description": "Same as Str.global_substitute, except that only the first substring matching the regular expression is replaced." }, - "type": "Str.regexp -> (string -> string) -> string -> string", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string -> string" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.replace_matched", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|8013" }, - "info": - { "description": "replace_matched repl s returns the replacement text repl in which \\1, \\2, etc. have been replaced by the text matched by the corresponding groups in the most recent matching operation. s must be the same string that was matched during this matching operation." }, - "type": "string -> string -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "string" } ] } }, - { "comment": "
Splitting
" }, - { "value": - { "name": "Str.split", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|8377" }, - "info": - { "description": "split r s splits s into substrings, taking as delimiters the substrings that match r, and returns the list of substrings. For instance, split (regexp \"[ \\t]+\") s splits s into blank-separated words. An occurrence of the delimiter at the beginning and at the end of the string is ignored." }, - "type": "Str.regexp -> string -> string list", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.bounded_split", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|8740" }, - "info": - { "description": "Same as Str.split, but splits into at most n substrings, where n is the extra integer parameter." }, - "type": "Str.regexp -> string -> int -> string list", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.split_delim", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|8914" }, - "info": - { "description": "Same as Str.split but occurrences of the delimiter at the beginning and at the end of the string are recognized and returned as empty strings in the result. For instance, split_delim (regexp \" \") \" abc \" returns [\"\"; \"abc\"; \"\"], while split with the same arguments returns [\"abc\"]." }, - "type": "Str.regexp -> string -> string list", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.bounded_split_delim", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|9280" }, - "info": - { "description": "Same as Str.bounded_split, but occurrences of the delimiter at the beginning and at the end of the string are recognized and returned as empty strings in the result." }, - "type": "Str.regexp -> string -> int -> string list", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "type": - { "name": "Str.split_result", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|9533" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Text", - "type": [ "string" ] }, - { "name": "Delim", - "type": [ "string" ] } ] } } }, - { "value": - { "name": "Str.full_split", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|9588" }, - "info": - { "description": "Same as Str.split_delim, but returns the delimiters as well as the substrings contained between delimiters. The former are tagged Delim in the result list; the latter are tagged Text. For instance, full_split (regexp \"[{}]\") \"{ab}\" returns [Delim \"{\"; Text \"ab\"; Delim \"}\"]." }, - "type": "Str.regexp -> string -> Str.split_result list", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Str.bounded_full_split", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|9954" }, - "info": - { "description": "Same as Str.bounded_split_delim, but returns the delimiters as well as the substrings contained between delimiters. The former are tagged Delim in the result list; the latter are tagged Text." }, - "type": "Str.regexp -> string -> int -> Str.split_result list", - "params": [ - { "name": "", - "type": "Str.regexp" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "comment": "
Extracting substrings
" }, - { "value": - { "name": "Str.string_before", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|10277" }, - "info": - { "description": "string_before s n returns the substring of all characters of s that precede position n (excluding the character at position n)." }, - "type": "string -> int -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.string_after", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|10471" }, - "info": - { "description": "string_after s n returns the substring of all characters of s that follow position n (including the character at position n)." }, - "type": "string -> int -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.first_chars", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|10662" }, - "info": - { "description": "first_chars s n returns the first n characters of s. This is the same function as Str.string_before." }, - "type": "string -> int -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Str.last_chars", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/str.mli|10825" }, - "info": - { "description": "last_chars s n returns the last n characters of s." }, - "type": "string -> int -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Stream.json b/data/Stream.json deleted file mode 100644 index b1c83aa..0000000 --- a/data/Stream.json +++ /dev/null @@ -1,170 +0,0 @@ -{ "module": - { "name": "Stream", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|0" }, - "info": - { "description": "Streams and parsers." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Stream.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|981" }, - "info": - { "description": "The type of streams holding values of type 'a." }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "exception": - { "name": "Stream.Failure", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|1044" }, - "info": - { "description": "Raised by parsers when none of the first components of the stream patterns is accepted." } } }, - { "exception": - { "name": "Stream.Error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|1161" }, - "info": - { "description": "Raised by parsers when the first component of a stream pattern is accepted, but one of the following components is rejected." }, - "exception_args": [ "string" ] } }, - { "comment": "
Stream builders


Warning: these functions create streams with fast access; it is illegal to mix them with streams built with [< >]; would raise Failure when accessing such mixed streams." }, - { "value": - { "name": "Stream.from", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|1536" }, - "info": - { "description": "Stream.from f returns a stream built from the function f. To create a new stream element, the function f is called with the current stream count. The user function f must return either Some <value> for a value or None to specify the end of the stream." }, - "type": "(int -> 'a option) -> 'a Stream.t", - "params": [ - { "name": "", - "type": "int -> 'a option" } ] } }, - { "value": - { "name": "Stream.of_list", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|1858" }, - "info": - { "description": "Return the stream holding the elements of the list in the same order." }, - "type": "'a list -> 'a Stream.t", - "params": [ - { "name": "", - "type": "'a list" } ] } }, - { "value": - { "name": "Stream.of_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|1969" }, - "info": - { "description": "Return the stream of the characters of the string parameter." }, - "type": "string -> char Stream.t", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Stream.of_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|2071" }, - "info": - { "description": "Return the stream of the characters read from the input channel." }, - "type": "Pervasives.in_channel -> char Stream.t", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "comment": "
Stream iterator
" }, - { "value": - { "name": "Stream.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|2211" }, - "info": - { "description": "Stream.iter f s scans the whole stream s, applying function f in turn to each stream element encountered." }, - "type": "('a -> unit) -> 'a Stream.t -> unit", - "params": [ - { "name": "", - "type": "'a -> unit" }, - { "name": "", - "type": "'a Stream.t" } ] } }, - { "comment": "
Predefined parsers
" }, - { "value": - { "name": "Stream.next", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|2404" }, - "info": - { "description": "Return the first element of the stream and remove it from the stream. Raise Stream.Failure if the stream is empty." }, - "type": "'a Stream.t -> 'a", - "params": [ - { "name": "", - "type": "'a Stream.t" } ] } }, - { "value": - { "name": "Stream.empty", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|2552" }, - "info": - { "description": "Return () if the stream is empty, else raise Stream.Failure." }, - "type": "'a Stream.t -> unit", - "params": [ - { "name": "", - "type": "'a Stream.t" } ] } }, - { "comment": "
Useful functions
" }, - { "value": - { "name": "Stream.peek", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|2680" }, - "info": - { "description": "Return Some of \"the first element\" of the stream, or None if the stream is empty." }, - "type": "'a Stream.t -> 'a option", - "params": [ - { "name": "", - "type": "'a Stream.t" } ] } }, - { "value": - { "name": "Stream.junk", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|2806" }, - "info": - { "description": "Remove the first element of the stream, possibly unfreezing it before." }, - "type": "'a Stream.t -> unit", - "params": [ - { "name": "", - "type": "'a Stream.t" } ] } }, - { "value": - { "name": "Stream.count", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|2912" }, - "info": - { "description": "Return the current count of the stream elements, i.e. the number of the stream elements discarded." }, - "type": "'a Stream.t -> int", - "params": [ - { "name": "", - "type": "'a Stream.t" } ] } }, - { "value": - { "name": "Stream.npeek", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/stream.mli|3046" }, - "info": - { "description": "npeek n returns the list of the n first elements of the stream, or all its remaining elements if less than n elements are available." }, - "type": "int -> 'a Stream.t -> 'a list", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a Stream.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ "Utf8", "Utf16", "Ulexing" ] } } } \ No newline at end of file diff --git a/data/String.json b/data/String.json deleted file mode 100644 index 0372778..0000000 --- a/data/String.json +++ /dev/null @@ -1,342 +0,0 @@ -{ "module": - { "name": "String", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|0" }, - "info": - { "description": "String operations. Given a string s of length l, we call character number in s the index of a character in s. Indexes start at 0, and we will call a character number valid in s if it falls within the range [0...l-1]. A position is the point between two characters or at the beginning or end of the string. We call a position valid in s if it falls within the range [0...l]. Note that character number n is between positions n and n+1.

Two parameters start and len are said to designate a valid substring of s if len >= 0 and start and start+len are valid positions in s." }, - "type": "sig end", - "module_structure": [ - { "value": - { "name": "String.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|1589" }, - "info": - { "description": "Return the length (number of characters) of the given string." }, - "type": "string -> int", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "String.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|1710" }, - "info": - { "description": "String.get s n returns character number n in string s. You can also write s.[n] instead of String.get s n.

Raise Invalid_argument if n not a valid character number in s." }, - "type": "string -> int -> char", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "String.set", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|1970" }, - "info": - { "description": "String.set s n c modifies string s in place, replacing the character number n by c. You can also write s.[n] <- c instead of String.set s n c.

Raise Invalid_argument if n is not a valid character number in s." }, - "type": "string -> int -> char -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|2281" }, - "info": - { "description": "String.create n returns a fresh string of length n. The string initially contains arbitrary characters.

Raise Invalid_argument if n < 0 or n > Sys.max_string_length." }, - "type": "int -> string", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "String.make", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|2530" }, - "info": - { "description": "String.make n c returns a fresh string of length n, filled with the character c.

Raise Invalid_argument if n < 0 or n > Sys.max_string_length." }, - "type": "int -> char -> string", - "params": [ - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|2735" }, - "info": - { "description": "Return a copy of the given string." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "String.sub", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|2806" }, - "info": - { "description": "String.sub s start len returns a fresh string of length len, containing the substring of s that starts at position start and has length len.

Raise Invalid_argument if start and len do not designate a valid substring of s." }, - "type": "string -> int -> int -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "String.fill", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|3108" }, - "info": - { "description": "String.fill s start len c modifies string s in place, replacing len characters by c, starting at start.

Raise Invalid_argument if start and len do not designate a valid substring of s." }, - "type": "string -> int -> int -> char -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.blit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|3377" }, - "info": - { "description": "String.blit src srcoff dst dstoff len copies len characters from string src, starting at character number srcoff, to string dst, starting at character number dstoff. It works correctly even if src and dst are the same string, and the source and destination intervals overlap.

Raise Invalid_argument if srcoff and len do not designate a valid substring of src, or if dstoff and len do not designate a valid substring of dst." }, - "type": "string -> int -> string -> int -> int -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "String.concat", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|3918" }, - "info": - { "description": "String.concat sep sl concatenates the list of strings sl, inserting the separator string sep between each." }, - "type": "string -> string list -> string", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "string list" } ] } }, - { "value": - { "name": "String.iter", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|4087" }, - "info": - { "description": "String.iter f s applies function f in turn to all the characters of s. It is equivalent to f s.[0]; f s.[1]; ...; f s.[String.length s - 1]; ()." }, - "type": "(char -> unit) -> string -> unit", - "params": [ - { "name": "", - "type": "char -> unit" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "String.escaped", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|4299" }, - "info": - { "description": "Return a copy of the argument, with special characters represented by escape sequences, following the lexical conventions of Objective Caml. If there is no special character in the argument, return the original string itself, not a copy." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "String.index", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|4589" }, - "info": - { "description": "String.index s c returns the character number of the first occurrence of character c in string s.

Raise Not_found if c does not occur in s." }, - "type": "string -> char -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.rindex", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|4790" }, - "info": - { "description": "String.rindex s c returns the character number of the last occurrence of character c in string s.

Raise Not_found if c does not occur in s." }, - "type": "string -> char -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.index_from", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|4992" }, - "info": - { "description": "String.index_from s i c returns the character number of the first occurrence of character c in string s after position i. String.index s c is equivalent to String.index_from s 0 c.

Raise Invalid_argument if i is not a valid position in s. Raise Not_found if c does not occur in s after position i." }, - "type": "string -> int -> char -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.rindex_from", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|5383" }, - "info": - { "description": "String.rindex_from s i c returns the character number of the last occurrence of character c in string s before position i+1. String.rindex s c is equivalent to String.rindex_from s (String.length s - 1) c.

Raise Invalid_argument if i+1 is not a valid position in s. Raise Not_found if c does not occur in s before position i+1." }, - "type": "string -> int -> char -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.contains", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|5808" }, - "info": - { "description": "String.contains s c tests if character c appears in the string s." }, - "type": "string -> char -> bool", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.contains_from", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|5929" }, - "info": - { "description": "String.contains_from s start c tests if character c appears in s after position start. String.contains s c is equivalent to String.contains_from s 0 c.

Raise Invalid_argument if start is not a valid position in s." }, - "type": "string -> int -> char -> bool", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.rcontains_from", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|6232" }, - "info": - { "description": "String.rcontains_from s stop c tests if character c appears in s before position stop+1.

Raise Invalid_argument if stop < 0 or stop+1 is not a valid position in s." }, - "type": "string -> int -> char -> bool", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "String.uppercase", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|6481" }, - "info": - { "description": "Return a copy of the argument, with all lowercase letters translated to uppercase, including accented letters of the ISO Latin-1 (8859-1) character set." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "String.lowercase", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|6681" }, - "info": - { "description": "Return a copy of the argument, with all uppercase letters translated to lowercase, including accented letters of the ISO Latin-1 (8859-1) character set." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "String.capitalize", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|6881" }, - "info": - { "description": "Return a copy of the argument, with the first character set to uppercase." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "String.uncapitalize", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|6997" }, - "info": - { "description": "Return a copy of the argument, with the first character set to lowercase." }, - "type": "string -> string", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "type": - { "name": "String.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|7120" }, - "info": - { "description": "An alias for the type of strings." }, - "params": [ ], - "kind": - { "type": "abstract" }, - "manifest": "string" } }, - { "value": - { "name": "String.compare", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/string.mli|7173" }, - "info": - { "description": "The comparison function for strings, with the same specification as Pervasives.compare. Along with the type t, this function compare allows the module String to be passed as argument to the functors Set.Make and Map.Make." }, - "type": "String.t -> String.t -> int", - "params": [ - { "name": "", - "type": "String.t" }, - { "name": "", - "type": "String.t" } ] } } ], - "dependencies": - { "uses": [ ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Sys.json b/data/Sys.json deleted file mode 100644 index 470e0ca..0000000 --- a/data/Sys.json +++ /dev/null @@ -1,50 +0,0 @@ -{ "module": - { "name": "Sys", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sys.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sys.mli|0" }, - "info": - { "description": "System interface." }, - "type": "sig end", - "module_structure": [ - { "comment": "System interface." }, - { "value": - { "name": "Sys.os_type", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sys.mli|991" }, - "info": - { "description": "Operating system currently executing the Caml program. One of" }, - "type": "string", - "params": [ ] } }, - { "value": - { "name": "Sys.word_size", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sys.mli|1277" }, - "info": - { "description": "Size of one word on the machine currently executing the Caml program, in bits: 32 or 64." }, - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Sys.max_string_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sys.mli|1397" }, - "info": - { "description": "Maximum length of a string." }, - "type": "int", - "params": [ ] } }, - { "value": - { "name": "Sys.max_array_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/sys.mli|1461" }, - "info": - { "description": "Maximum length of a normal array. The maximum length of a float array is max_array_length/2 on 32-bit machines and max_array_length on 64-bit machines." }, - "type": "int", - "params": [ ] } } ], - "dependencies": - { "uses": [ "Pervasives" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Ulexing.json b/data/Ulexing.json deleted file mode 100644 index e8a8817..0000000 --- a/data/Ulexing.json +++ /dev/null @@ -1,436 +0,0 @@ -{ "module": - { "name": "Ulexing", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|0" }, - "info": - { "description": "Runtime support for lexers generated by ulex. This module is roughly equivalent to the module Lexing from the OCaml standard library, except that its lexbuffers handles Unicode code points (OCaml type: int in the range 0..0x10ffff) instead of bytes (OCaml type: char).

It is possible to have ulex-generated lexers work on a custom implementation for lex buffers. To do this, define a module L which implements the start, next, mark and backtrack functions (See the Internal Interface section below for a specification), and the Error exception. They need not work on a type named lexbuf: you can use the type name you want. Then, just do in your ulex-processed source, before the first lexer specification:

module Ulexing = L

Of course, you'll probably want to define functions like lexeme to be used in the lexers semantic actions." }, - "type": "sig end", - "module_structure": [ - { "type": - { "name": "Ulexing.lexbuf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|908" }, - "info": - { "description": "The type of lexer buffers. A lexer buffer is the argument passed to the scanning functions defined by the generated lexers. The lexer buffer holds the internal information for the scanners, including the code points of the token currently scanned, its position from the beginning of the input stream, and the current position of the lexer." }, - "params": [ ], - "kind": - { "type": "abstract" } } }, - { "exception": - { "name": "Ulexing.Error", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|1285" }, - "info": - { "description": "Raised by a lexer when it cannot parse a token from the lexbuf. The functions Ulexing.lexeme_start (resp. Ulexing.lexeme_end) can be used to find to positions of the first code point of the current matched substring (resp. the first code point that yield the error)." } } }, - { "exception": - { "name": "Ulexing.InvalidCodepoint", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|1596" }, - "info": - { "description": "Raised by some functions to signal that some code point is not compatible with a specified encoding." }, - "exception_args": [ "int" ] } }, - { "comment": "
Clients interface
" }, - { "value": - { "name": "Ulexing.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|1775" }, - "info": - { "description": "Create a generic lexer buffer. When the lexer needs more characters, it will call the given function, giving it an array of integers a, a position pos and a code point count n. The function should put n code points or less in a, starting at position pos, and return the number of characters provided. A return value of 0 means end of input." }, - "type": "(int array -> int -> int -> int) -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "int array -> int -> int -> int" } ] } }, - { "value": - { "name": "Ulexing.from_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|2217" }, - "info": - { "description": "Create a lexbuf from a stream of Unicode code points." }, - "type": "int Stream.t -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "int Stream.t" } ] } }, - { "value": - { "name": "Ulexing.from_int_array", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|2321" }, - "info": - { "description": "Create a lexbuf from an array of Unicode code points." }, - "type": "int array -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "int array" } ] } }, - { "value": - { "name": "Ulexing.from_latin1_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|2425" }, - "info": - { "description": "Create a lexbuf from a Latin1 encoded stream (ie a stream of Unicode code points in the range 0..255)" }, - "type": "char Stream.t -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "char Stream.t" } ] } }, - { "value": - { "name": "Ulexing.from_latin1_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|2591" }, - "info": - { "description": "Create a lexbuf from a Latin1 encoded input channel. The client is responsible for closing the channel." }, - "type": "Pervasives.in_channel -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Ulexing.from_latin1_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|2755" }, - "info": - { "description": "Create a lexbuf from a Latin1 encoded string." }, - "type": "string -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Ulexing.from_utf8_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|2852" }, - "info": - { "description": "Create a lexbuf from a UTF-8 encoded stream." }, - "type": "char Stream.t -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "char Stream.t" } ] } }, - { "value": - { "name": "Ulexing.from_utf8_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|2953" }, - "info": - { "description": "Create a lexbuf from a UTF-8 encoded input channel." }, - "type": "Pervasives.in_channel -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "value": - { "name": "Ulexing.from_utf8_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|3059" }, - "info": - { "description": "Create a lexbuf from a UTF-8 encoded string." }, - "type": "string -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "string" } ] } }, - { "type": - { "name": "Ulexing.enc", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|3158" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Ascii", - "type": [ ] }, - { "name": "Latin1", - "type": [ ] }, - { "name": "Utf8", - "type": [ ] } ] } } }, - { "value": - { "name": "Ulexing.from_var_enc_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|3186" }, - "info": - { "description": "Create a lexbuf from a stream whose encoding is subject to change during lexing. The reference can be changed at any point. Note that bytes that have been consumed by the lexer buffer are not re-interpreted with the new encoding.

In Ascii mode, non-ASCII bytes (ie >127) in the stream raise an InvalidCodepoint exception." }, - "type": "Ulexing.enc Pervasives.ref -> char Stream.t -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "Ulexing.enc Pervasives.ref" }, - { "name": "", - "type": "char Stream.t" } ] } }, - { "value": - { "name": "Ulexing.from_var_enc_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|3605" }, - "info": - { "description": "Same as Ulexing.from_var_enc_stream with a string as input." }, - "type": "Ulexing.enc Pervasives.ref -> string -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "Ulexing.enc Pervasives.ref" }, - { "name": "", - "type": "string" } ] } }, - { "value": - { "name": "Ulexing.from_var_enc_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|3730" }, - "info": - { "description": "Same as Ulexing.from_var_enc_stream with a channel as input." }, - "type": "Ulexing.enc Pervasives.ref -> Pervasives.in_channel -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "Ulexing.enc Pervasives.ref" }, - { "name": "", - "type": "Pervasives.in_channel" } ] } }, - { "comment": "
Interface for lexers semantic actions
" }, - { "comment": "The following functions can be called from the semantic actions of lexer definitions. They give access to the character string matched by the regular expression associated with the semantic action. These functions must be applied to the argument lexbuf, which, in the code generated by ulex, is bound to the lexer buffer passed to the parsing function.

These functions can also be called when capturing a Ulexing.Error exception to retrieve the problematic string." }, - { "value": - { "name": "Ulexing.lexeme_start", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|4407" }, - "info": - { "description": "Ulexing.lexeme_start lexbuf returns the offset in the input stream of the first code point of the matched string. The first code point of the stream has offset 0." }, - "type": "Ulexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.lexeme_end", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|4622" }, - "info": - { "description": "Ulexing.lexeme_end lexbuf returns the offset in the input stream of the character following the last code point of the matched string. The first character of the stream has offset 0." }, - "type": "Ulexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.loc", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|4851" }, - "info": - { "description": "Ulexing.loc lexbuf returns the pair (Ulexing.lexeme_start lexbuf,Ulexing.lexeme_end lexbuf)." }, - "type": "Ulexing.lexbuf -> int * int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.lexeme_length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|4988" }, - "info": - { "description": "Ulexing.loc lexbuf returns the difference (Ulexing.lexeme_end lexbuf) - (Ulexing.lexeme_start lexbuf), that is, the length (in code points) of the matched string." }, - "type": "Ulexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|5201" }, - "info": - { "description": "Ulexing.lexeme lexbuf returns the string matched by the regular expression as an array of Unicode code point." }, - "type": "Ulexing.lexbuf -> int array", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.get_buf", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|5355" }, - "info": - { "description": "Direct access to the internal buffer." }, - "type": "Ulexing.lexbuf -> int array", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.get_start", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|5435" }, - "info": - { "description": "Direct access to the starting position of the lexeme in the internal buffer." }, - "type": "Ulexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.get_pos", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|5556" }, - "info": - { "description": "Direct access to the current position (end of lexeme) in the internal buffer." }, - "type": "Ulexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.lexeme_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|5677" }, - "info": - { "description": "Ulexing.lexeme_char lexbuf pos returns code point number pos in the matched string." }, - "type": "Ulexing.lexbuf -> int -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Ulexing.sub_lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|5819" }, - "info": - { "description": "Ulexing.lexeme lexbuf pos len returns a substring of the string matched by the regular expression as an array of Unicode code point." }, - "type": "Ulexing.lexbuf -> int -> int -> int array", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Ulexing.latin1_lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|6015" }, - "info": - { "description": "As Ulexing.lexeme with a result encoded in Latin1. This function throws an exception InvalidCodepoint if it is not possible to encode the result in Latin1." }, - "type": "Ulexing.lexbuf -> string", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.latin1_sub_lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|6223" }, - "info": - { "description": "As Ulexing.sub_lexeme with a result encoded in Latin1. This function throws an exception InvalidCodepoint if it is not possible to encode the result in Latin1." }, - "type": "Ulexing.lexbuf -> int -> int -> string", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Ulexing.latin1_lexeme_char", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|6453" }, - "info": - { "description": "As Ulexing.lexeme_char with a result encoded in Latin1. This function throws an exception InvalidCodepoint if it is not possible to encode the result in Latin1." }, - "type": "Ulexing.lexbuf -> int -> char", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Ulexing.utf8_lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|6678" }, - "info": - { "description": "As Ulexing.lexeme with a result encoded in UTF-8." }, - "type": "Ulexing.lexbuf -> string", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.utf8_sub_lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|6772" }, - "info": - { "description": "As Ulexing.sub_lexeme with a result encoded in UTF-8." }, - "type": "Ulexing.lexbuf -> int -> int -> string", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Ulexing.rollback", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|6889" }, - "info": - { "description": "Ulexing.rollback lexbuf puts lexbuf back in its configuration before the last lexeme was matched. It is then possible to use another lexer to parse the same characters again. The other functions above in this section should not be used in the semantic action after a call to Ulexing.rollback." }, - "type": "Ulexing.lexbuf -> unit", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "comment": "
Internal interface
" }, - { "comment": "These functions are used internally by the lexers. They could be used to write lexers by hand, or with a lexer generator different from ulex. The lexer buffers have a unique internal slot that can store an integer. They also store a \"backtrack\" position." }, - { "value": - { "name": "Ulexing.start", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|7535" }, - "info": - { "description": "Ulexing.start lexbuf informs the lexer buffer that any code points until the current position can be discarded. The current position become the \"start\" position as returned by Ulexing.lexeme_start. Moreover, the internal slot is set to -1 and the backtrack position is set to the current position." }, - "type": "Ulexing.lexbuf -> unit", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.next", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|7881" }, - "info": - { "description": "Ulexing.next lexbuf next extracts the next code point from the lexer buffer and increments to current position. If the input stream is exhausted, the function returns -1." }, - "type": "Ulexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } }, - { "value": - { "name": "Ulexing.mark", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|8092" }, - "info": - { "description": "Ulexing.mark lexbuf i stores the integer i in the internal slot. The backtrack position is set to the current position." }, - "type": "Ulexing.lexbuf -> int -> unit", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Ulexing.backtrack", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/ulexing.mli|8258" }, - "info": - { "description": "Ulexing.backtrack lexbuf returns the value stored in the internal slot of the buffer, and performs backtracking (the current position is set to the value of the backtrack position)." }, - "type": "Ulexing.lexbuf -> int", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" } ] } } ], - "dependencies": - { "uses": [ "Stream" ], - "used_by": [ "Utf16" ] } } } \ No newline at end of file diff --git a/data/Utf16.json b/data/Utf16.json deleted file mode 100644 index c65438a..0000000 --- a/data/Utf16.json +++ /dev/null @@ -1,283 +0,0 @@ -{ "module": - { "name": "Utf16", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|0" }, - "info": - { "description": "UTF-16 support for Ulex. Implementation as described in \"http://www.ietf.org/rfc/rfc2781.txt\"." }, - "type": "sig end", - "module_structure": [ - { "exception": - { "name": "Utf16.MalFormed", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|108" }, - "info": "" } }, - { "comment": "UTF-16 can be encoded in little endian format (0xabcd -> (0xcd|0xab)) or big endian format (0xabcd -> (0xab|0xcd)." }, - { "type": - { "name": "Utf16.byte_order", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|261" }, - "info": "", - "params": [ ], - "kind": - { "type": "variant", - "private": "false", - "constructors": [ - { "name": "Little_endian", - "type": [ ] }, - { "name": "Big_endian", - "type": [ ] } ] } } }, - { "comment": "
Interface
" }, - { "value": - { "name": "Utf16.to_int_array", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|703" }, - "info": - { "description": "to_int_array opt_bo str spos bytes decodes the string str of length bytes starting in position spos. If opt_bo matches with None the functions tries to detect a BOM, if it can't it assumes big endian byte order. If opt_bo matches with Some bo byte order bo is assumed and potential byte order marks are interpreted as code points 0xfeff." }, - "type": "Utf16.byte_order option -> string -> int -> int -> int array", - "params": [ - { "name": "", - "type": "Utf16.byte_order option" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf16.from_int_array", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|986" }, - "info": - { "description": "from_int_array bo a apos len bom encodes an int array a containing len code points from position apos into a string with byte order bo. The results starts with a BOM if bom = true." }, - "type": "Utf16.byte_order -> int array -> int -> int -> bool -> string", - "params": [ - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "int array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Utf16.stream_from_char_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|1216" }, - "info": - { "description": "stream_from_char_stream opt_stro creates a new int stream containing the code points encoded in str. Treats opt_bo as to_int_array." }, - "type": "Utf16.byte_order option -> char Stream.t -> int Stream.t", - "params": [ - { "name": "", - "type": "Utf16.byte_order option" }, - { "name": "", - "type": "char Stream.t" } ] } }, - { "comment": "
Low level
" }, - { "value": - { "name": "Utf16.get_byte_order", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|1424" }, - "info": - { "description": "get_byte_order c1 c2 determines the byte order by a pair of bytes/characters c1 and c2." }, - "type": "char -> char -> Utf16.byte_order", - "params": [ - { "name": "", - "type": "char" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Utf16.from_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|1570" }, - "info": - { "description": "from_stream bo s reads the next code point from a stream encoded in byte order bo." }, - "type": "Utf16.byte_order -> char Stream.t -> int", - "params": [ - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "char Stream.t" } ] } }, - { "value": - { "name": "Utf16.number_of_char_pair", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|1739" }, - "info": - { "description": "number_of_char_pair bo c1 c2 returns the code point encoded in c1 and c2 following byte order bo." }, - "type": "Utf16.byte_order -> char -> char -> int", - "params": [ - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "char" }, - { "name": "", - "type": "char" } ] } }, - { "value": - { "name": "Utf16.char_pair_of_number", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|1904" }, - "info": - { "description": "char_pair_of_number bo cp encodes code point cp into two characters with byte order bo." }, - "type": "Utf16.byte_order -> int -> char * char", - "params": [ - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf16.next_code", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|2093" }, - "info": - { "description": "next_code bo s pos bytes bo reads the code point starting at position pos in a string s of total length bytes." }, - "type": "Utf16.byte_order -> string -> int -> int -> int * int", - "params": [ - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf16.compute_len", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|2298" }, - "info": - { "description": "compute_len opt_bo str pos len computes the number of encoded code points in string str from position pos to pos+len-1." }, - "type": "Utf16.byte_order option -> string -> int -> int -> int", - "params": [ - { "name": "", - "type": "Utf16.byte_order option" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf16.blit_to_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|2514" }, - "info": - { "description": "blit_to_int bo str spos a apos n decode len bytes from string str starting at position spos into array a, at position apos." }, - "type": "Utf16.byte_order option -> string -> int -> int array -> int -> int -> unit", - "params": [ - { "name": "", - "type": "Utf16.byte_order option" }, - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf16.store", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|2703" }, - "info": - { "description": "store bo buf cp adds a codepoint cp to a buffer buf following the byte order bo." }, - "type": "Utf16.byte_order -> Buffer.t -> int -> unit", - "params": [ - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf16.from_utf16_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|2756" }, - "info": - { "description": "from_utf16_stream s opt_bo creates a lexbuf from an UTF-16 encoded stream. If opt_bo matches with None the function expects a BOM (Byte Order Mark), and takes the byte order as Utf16.Big_endian if it cannot find one. When opt_bo matches with Some bo, bo is taken as byte order. In this case a leading BOM is kept in the stream - the lexer has to ignore it and a `wrong' BOM (0xfffe) will raise Utf16.InvalidCodepoint." }, - "type": "char Stream.t -> Utf16.byte_order option -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "char Stream.t" }, - { "name": "", - "type": "Utf16.byte_order option" } ] } }, - { "value": - { "name": "Utf16.from_utf16_channel", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|3317" }, - "info": - { "description": "Works as from_utf16_stream with an in_channel." }, - "type": "Pervasives.in_channel -> Utf16.byte_order option -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "Pervasives.in_channel" }, - { "name": "", - "type": "Utf16.byte_order option" } ] } }, - { "value": - { "name": "Utf16.from_utf16_string", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|3517" }, - "info": - { "description": "Works as from_utf16_stream with a string." }, - "type": "string -> Utf16.byte_order option -> Ulexing.lexbuf", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "Utf16.byte_order option" } ] } }, - { "value": - { "name": "Utf16.utf16_lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|3705" }, - "info": - { "description": "utf16_lexeme lb bo bom as Ulexing.lexeme with a result encoded in UTF-16 in byte_order bo and starting with a BOM if bom = true." }, - "type": "Ulexing.lexbuf -> Utf16.byte_order -> bool -> string", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "bool" } ] } }, - { "value": - { "name": "Utf16.utf16_sub_lexeme", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf16.mli|3975" }, - "info": - { "description": "utf16_sub_lexeme lb pos len bo bom as Ulexing.sub_lexeme with a result encoded in UTF-16 with byte order bo and starting with a BOM if bom=true" }, - "type": "Ulexing.lexbuf -> int -> int -> Utf16.byte_order -> bool -> string", - "params": [ - { "name": "", - "type": "Ulexing.lexbuf" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "Utf16.byte_order" }, - { "name": "", - "type": "bool" } ] } } ], - "dependencies": - { "uses": [ "Ulexing", "Stream", "Buffer" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Utf8.json b/data/Utf8.json deleted file mode 100644 index 181f992..0000000 --- a/data/Utf8.json +++ /dev/null @@ -1,130 +0,0 @@ -{ "module": - { "name": "Utf8", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|0" }, - "info": "", - "type": "sig end", - "module_structure": [ - { "exception": - { "name": "Utf8.MalFormed", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|0" }, - "info": "" } }, - { "value": - { "name": "Utf8.width", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|21" }, - "info": "", - "type": "int array", - "params": [ ] } }, - { "value": - { "name": "Utf8.next", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|42" }, - "info": "", - "type": "string -> int -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf8.compute_len", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|73" }, - "info": "", - "type": "string -> int -> int -> int", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf8.blit_to_int", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|118" }, - "info": "", - "type": "string -> int -> int array -> int -> int -> unit", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf8.to_int_array", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|184" }, - "info": "", - "type": "string -> int -> int -> int array", - "params": [ - { "name": "", - "type": "string" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf8.store", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|237" }, - "info": "", - "type": "Buffer.t -> int -> unit", - "params": [ - { "name": "", - "type": "Buffer.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf8.from_int_array", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|272" }, - "info": "", - "type": "int array -> int -> int -> string", - "params": [ - { "name": "", - "type": "int array" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Utf8.from_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|327" }, - "info": "", - "type": "char Stream.t -> int", - "params": [ - { "name": "", - "type": "char Stream.t" } ] } }, - { "value": - { "name": "Utf8.stream_from_char_stream", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/utf8.mli|365" }, - "info": "", - "type": "char Stream.t -> int Stream.t", - "params": [ - { "name": "", - "type": "char Stream.t" } ] } } ], - "dependencies": - { "uses": [ "Stream", "Buffer" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/Weak.json b/data/Weak.json deleted file mode 100644 index 43df5fb..0000000 --- a/data/Weak.json +++ /dev/null @@ -1,166 +0,0 @@ -{ "module": - { "name": "Weak", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|0" }, - "info": - { "description": "Arrays of weak pointers and hash tables of weak pointers." }, - "type": "sig end", - "module_structure": [ - { "comment": "
Low-level functions
" }, - { "type": - { "name": "Weak.t", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|1049" }, - "info": - { "description": "The type of arrays of weak pointers (weak arrays). A weak pointer is a value that the garbage collector may erase whenever the value is not used any more (through normal pointers) by the program. Note that finalisation functions are run after the weak pointers are erased.

A weak pointer is said to be full if it points to a value, empty if the value was erased by the GC.

Notes:" }, - "params": [ - { "covariant": "true", - "contravariant": "true", - "type": "'b" } ], - "kind": - { "type": "abstract" } } }, - { "value": - { "name": "Weak.create", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|1657" }, - "info": - { "description": "Weak.create n returns a new weak array of length n. All the pointers are initially empty. Raise Invalid_argument if n is negative or greater than Sys.max_array_length-1." }, - "type": "int -> 'a Weak.t", - "params": [ - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Weak.length", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|1879" }, - "info": - { "description": "Weak.length ar returns the length (number of elements) of ar." }, - "type": "'a Weak.t -> int", - "params": [ - { "name": "", - "type": "'a Weak.t" } ] } }, - { "value": - { "name": "Weak.set", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|1980" }, - "info": - { "description": "Weak.set ar n (Some el) sets the nth cell of ar to be a (full) pointer to el; Weak.set ar n None sets the nth cell of ar to empty. Raise Invalid_argument \"Weak.set\" if n is not in the range 0 to Weak.length a - 1." }, - "type": "'a Weak.t -> int -> 'a option -> unit", - "params": [ - { "name": "", - "type": "'a Weak.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a option" } ] } }, - { "value": - { "name": "Weak.get", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|2279" }, - "info": - { "description": "Weak.get ar n returns None if the nth cell of ar is empty, Some x (where x is the value) if it is full. Raise Invalid_argument \"Weak.get\" if n is not in the range 0 to Weak.length a - 1." }, - "type": "'a Weak.t -> int -> 'a option", - "params": [ - { "name": "", - "type": "'a Weak.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Weak.get_copy", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|2536" }, - "info": - { "description": "Weak.get_copy ar n returns None if the nth cell of ar is empty, Some x (where x is a (shallow) copy of the value) if it is full. In addition to pitfalls with mutable values, the interesting difference with get is that get_copy does not prevent the incremental GC from erasing the value in its current cycle (get may delay the erasure to the next GC cycle). Raise Invalid_argument \"Weak.get\" if n is not in the range 0 to Weak.length a - 1." }, - "type": "'a Weak.t -> int -> 'a option", - "params": [ - { "name": "", - "type": "'a Weak.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Weak.check", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|3073" }, - "info": - { "description": "Weak.check ar n returns true if the nth cell of ar is full, false if it is empty. Note that even if Weak.check ar n returns true, a subsequent Weak.get ar n can return None." }, - "type": "'a Weak.t -> int -> bool", - "params": [ - { "name": "", - "type": "'a Weak.t" }, - { "name": "", - "type": "int" } ] } }, - { "value": - { "name": "Weak.fill", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|3314" }, - "info": - { "description": "Weak.fill ar ofs len el sets to el all pointers of ar from ofs to ofs + len - 1. Raise Invalid_argument \"Weak.fill\" if ofs and len do not designate a valid subarray of a." }, - "type": "'a Weak.t -> int -> int -> 'a option -> unit", - "params": [ - { "name": "", - "type": "'a Weak.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a option" } ] } }, - { "value": - { "name": "Weak.blit", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|3568" }, - "info": - { "description": "Weak.blit ar1 off1 ar2 off2 len copies len weak pointers from ar1 (starting at off1) to ar2 (starting at off2). It works correctly even if ar1 and ar2 are the same. Raise Invalid_argument \"Weak.blit\" if off1 and len do not designate a valid subarray of ar1, or if off2 and len do not designate a valid subarray of ar2." }, - "type": "'a Weak.t -> int -> 'a Weak.t -> int -> int -> unit", - "params": [ - { "name": "", - "type": "'a Weak.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "'a Weak.t" }, - { "name": "", - "type": "int" }, - { "name": "", - "type": "int" } ] } }, - { "comment": "
Weak hash tables
" }, - { "comment": "A weak hash table is a hashed set of values. Each value may magically disappear from the set when it is not used by the rest of the program any more. This is normally used to share data structures without inducing memory leaks. Weak hash tables are defined on values from a Hashtbl.HashedType module; the equal relation and hash function are taken from that module. We will say that v is an instance of x if equal x v is true.

The equal relation must be able to work on a shallow copy of the values and give the same result as with the values themselves." }, - { "module_type": - { "name": "Weak.S", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|4646" }, - "info": - { "description": "The output signature of the functor Weak.Make." }, - "type": "sig end", - "kind": "" } }, - { "module": - { "name": "Weak.Make", - "file": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli", - "location": - { "implementation": "unknown", - "interface": "/Users/avsm/src/git/avsm/mirage/lib/_build/unix-socket/std/weak.mli|7147" }, - "info": - { "description": "Functor building an implementation of the weak hash table structure." }, - "type": "functor (H : Hashtbl.HashedType) -> sig end", - "module_functor": - { "parameter": - { "name": "H" }, - "module_with": "unavailable" }, - "dependencies": - { "uses": [ ] } } } ], - "dependencies": - { "uses": [ "Hashtbl" ], - "used_by": [ ] } } } \ No newline at end of file diff --git a/data/index.json b/data/index.json deleted file mode 100644 index 94da447..0000000 --- a/data/index.json +++ /dev/null @@ -1,249 +0,0 @@ -[ { "name": "Base64", -"info": - { "description": "decode a string encoded in base64. Will leave trailing NULLs on the string padding it out to a multiple of 3 characters" }, -"descr_cnt": 3.0000, -"compl_descr_cnt": 2.0000 }, { "name": "String", -"info": - { "description": "String operations. Given a string s of length l, we call character number in s the index of a character in s. Indexes start at 0, and we will call a character number valid in s if it falls within the range [0...l-1]. A position is the point between two characters or at the beginning or end of the string. We call a position valid in s if it falls within the range [0...l]. Note that character number n is between positions n and n+1.

Two parameters start and len are said to designate a valid substring of s if len >= 0 and start and start+len are valid positions in s." }, -"descr_cnt": 26.0000, -"compl_descr_cnt": 26.0000 }, { "name": "Stack", -"info": - { "description": "Last-in first-out stacks.

This module implements stacks (LIFOs), with in-place modification." }, -"descr_cnt": 12.0000, -"compl_descr_cnt": 12.0000 }, { "name": "Sort", -"info": - { "description": "Sorting and merging lists.", - "deprecated": "This module is obsolete and exists only for backward compatibility. The sorting functions in Array and List should be used instead. The new functions are faster and use less memory." }, -"descr_cnt": 4.0000, -"compl_descr_cnt": 4.0000 }, { "name": "Set", -"info": - { "description": "Sets over ordered types.

This module implements the set data structure, given a total ordering function over the set elements. All operations over sets are purely applicative (no side-effects). The implementation uses balanced binary trees, and is therefore reasonably efficient: insertion and membership take time logarithmic in the size of the set, for instance." }, -"descr_cnt": 4.0000, -"compl_descr_cnt": 4.0000 }, { "name": "Queue", -"info": - { "description": "First-in first-out queues.

This module implements queues (FIFOs), with in-place modification." }, -"descr_cnt": 17.0000, -"compl_descr_cnt": 17.0000 }, { "name": "Printexc", -"info": - { "description": "Facilities for printing exceptions." }, -"descr_cnt": 8.0000, -"compl_descr_cnt": 8.0000 }, { "name": "Pervasives", -"info": - { "description": "The initially opened module.

This module provides the basic operations over the built-in types (numbers, booleans, strings, exceptions, references, lists, arrays, input-output channels, ...).

This module is automatically opened at the beginning of each compilation. All components of this module can therefore be referred by their short name, without prefixing them by Pervasives." }, -"descr_cnt": 184.0000, -"compl_descr_cnt": 174.0000 }, { "name": "Nativeint", -"info": - { "description": "Processor-native integers.

This module provides operations on the type nativeint of signed 32-bit integers (on 32-bit platforms) or signed 64-bit integers (on 64-bit platforms). This integer type has exactly the same width as that of a long integer type in the C compiler. All arithmetic operations over nativeint are taken modulo 232 or 264 depending on the word size of the architecture.

Performance notice: values of type nativeint occupy more memory space than values of type int, and arithmetic operations on nativeint are generally slower than those on int. Use nativeint only when the application requires the extra bit of precision over the int type." }, -"descr_cnt": 33.0000, -"compl_descr_cnt": 33.0000 }, { "name": "Marshal", -"info": - { "description": "Marshaling of data structures.

This module provides functions to encode arbitrary data structures as sequences of bytes, which can then be written on a file or sent over a pipe or network connection. The bytes can then be read back later, possibly in another process, and decoded back into a data structure. The format for the byte sequences is compatible across all machines for a given version of Objective Caml.

Warning: marshaling is currently not type-safe. The type of marshaled data is not transmitted along the value of the data, making it impossible to check that the data read back possesses the type expected by the context. In particular, the result type of the Marshal.from_* functions is given as 'a, but this is misleading: the returned Caml value does not possess type 'a for all 'a; it has one, unique type which cannot be determined at compile-type. The programmer should explicitly give the expected type of the returned value, using the following syntax: The representation of marshaled values is not human-readable, and uses bytes that are not printable characters. Therefore, input and output channels used in conjunction with Marshal.to_channel and Marshal.from_channel must be opened in binary mode, using e.g. open_out_bin or open_in_bin; channels opened in text mode will cause unmarshaling errors on platforms where text channels behave differently than binary channels, e.g. Windows." }, -"descr_cnt": 10.0000, -"compl_descr_cnt": 10.0000 }, { "name": "Map", -"info": - { "description": "Association tables over ordered types.

This module implements applicative association tables, also known as finite maps or dictionaries, given a total ordering function over the keys. All operations over maps are purely applicative (no side-effects). The implementation uses balanced binary trees, and therefore searching and insertion take time logarithmic in the size of the map." }, -"descr_cnt": 4.0000, -"compl_descr_cnt": 4.0000 }, { "name": "Lazy", -"info": - { "description": "Deferred computations." }, -"descr_cnt": 8.0000, -"compl_descr_cnt": 6.0000 }, { "name": "Stream", -"info": - { "description": "Streams and parsers." }, -"descr_cnt": 15.0000, -"compl_descr_cnt": 15.0000 }, { "name": "List", -"info": - { "description": "List operations.

Some functions are flagged as not tail-recursive. A tail-recursive function uses constant stack space, while a non-tail-recursive function uses stack space proportional to the length of its list argument, which can be a problem with very long lists. When the function takes several list arguments, an approximate formula giving stack usage (in some unspecified constant unit) is shown in parentheses.

The above considerations can usually be ignored if your lists are not longer than about 10000 elements." }, -"descr_cnt": 42.0000, -"compl_descr_cnt": 42.0000 }, { "name": "Lexing", -"info": - { "description": "The run-time library for lexers generated by ocamllex." }, -"descr_cnt": 30.0000, -"compl_descr_cnt": 14.0000 }, { "name": "Int64", -"info": - { "description": "64-bit integers.

This module provides operations on the type int64 of signed 64-bit integers. Unlike the built-in int type, the type int64 is guaranteed to be exactly 64-bit wide on all platforms. All arithmetic operations over int64 are taken modulo 264

Performance notice: values of type int64 occupy more memory space than values of type int, and arithmetic operations on int64 are generally slower than those on int. Use int64 only when the application requires exact 64-bit arithmetic." }, -"descr_cnt": 36.0000, -"compl_descr_cnt": 36.0000 }, { "name": "Int32", -"info": - { "description": "32-bit integers.

This module provides operations on the type int32 of signed 32-bit integers. Unlike the built-in int type, the type int32 is guaranteed to be exactly 32-bit wide on all platforms. All arithmetic operations over int32 are taken modulo 232.

Performance notice: values of type int32 occupy more memory space than values of type int, and arithmetic operations on int32 are generally slower than those on int. Use int32 only when the application requires exact 32-bit arithmetic." }, -"descr_cnt": 32.0000, -"compl_descr_cnt": 32.0000 }, { "name": "Hashtbl", -"info": - { "description": "Hash tables and hash functions.

Hash tables are hashed association tables, with in-place modification." }, -"descr_cnt": 19.0000, -"compl_descr_cnt": 19.0000 }, { "name": "Gc", -"info": - { "description": "Memory management control and statistics; finalised values." }, -"descr_cnt": 42.0000, -"compl_descr_cnt": 42.0000 }, { "name": "Digest", -"info": - { "description": "MD5 message digest.

This module provides functions to compute 128-bit ``digests'' of arbitrary-length strings or files. The digests are of cryptographic quality: it is very hard, given a digest, to forge a string having that digest. The algorithm used is MD5." }, -"descr_cnt": 6.0000, -"compl_descr_cnt": 6.0000 }, { "name": "Complex", -"info": - { "description": "Complex numbers.

This module provides arithmetic operations on complex numbers. Complex numbers are represented by their real and imaginary parts (cartesian representation). Each part is represented by a double-precision floating-point number (type float)." }, -"descr_cnt": 22.0000, -"compl_descr_cnt": 20.0000 }, { "name": "Char", -"info": - { "description": "Character operations." }, -"descr_cnt": 8.0000, -"compl_descr_cnt": 8.0000 }, { "name": "CamlinternalLazy", -"info": "", -"descr_cnt": 6.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Callback", -"info": - { "description": "Registering Caml values with the C runtime.

This module allows Caml values to be registered with the C runtime under a symbolic name, so that C code can later call back registered Caml functions, or raise registered Caml exceptions." }, -"descr_cnt": 3.0000, -"compl_descr_cnt": 3.0000 }, { "name": "Buffer", -"info": - { "description": "Extensible string buffers.

This module implements string buffers that automatically expand as necessary. It provides accumulative concatenation of strings in quasi-linear time (instead of quadratic time when strings are concatenated pairwise)." }, -"descr_cnt": 15.0000, -"compl_descr_cnt": 15.0000 }, { "name": "Array", -"info": - { "description": "Array operations." }, -"descr_cnt": 26.0000, -"compl_descr_cnt": 24.0000 }, { "name": "Weak", -"info": - { "description": "Arrays of weak pointers and hash tables of weak pointers." }, -"descr_cnt": 12.0000, -"compl_descr_cnt": 12.0000 }, { "name": "Sys", -"info": - { "description": "System interface." }, -"descr_cnt": 5.0000, -"compl_descr_cnt": 5.0000 }, { "name": "Scanf", -"info": - { "description": "Formatted input functions." }, -"descr_cnt": 27.0000, -"compl_descr_cnt": 26.0000 }, { "name": "Random", -"info": - { "description": "Pseudo-random number generators (PRNG)." }, -"descr_cnt": 25.0000, -"compl_descr_cnt": 18.0000 }, { "name": "Obj", -"info": - { "description": "Operations on internal representations of values.

Not for the casual user." }, -"descr_cnt": 35.0000, -"compl_descr_cnt": 1.0000 }, { "name": "Format", -"info": - { "description": "Pretty printing.

This module implements a pretty-printing facility to format text within ``pretty-printing boxes''. The pretty-printer breaks lines at specified break hints, and indents lines according to the box structure.

For a gentle introduction to the basics of pretty-printing using Format, read http://caml.inria.fr/resources/doc/guides/format.html.

You may consider this module as providing an extension to the printf facility to provide automatic line breaking. The addition of pretty-printing annotations to your regular printf formats gives you fancy indentation and line breaks. Pretty-printing annotations are described below in the documentation of the function Format.fprintf.

You may also use the explicit box management and printing functions provided by this module. This style is more basic but more verbose than the fprintf concise formats.

For instance, the sequence open_box 0; print_string \"x =\"; print_space (); print_int 1; close_box (); print_newline () that prints x = 1 within a pretty-printing box, can be abbreviated as printf \"@[%s@ %i@]@.\" \"x =\" 1, or even shorter printf \"@[x =@ %i@]@.\" 1.

Rule of thumb for casual users of this library: The behaviour of pretty-printing commands is unspecified if there is no opened pretty-printing box. Each box opened via one of the open_ functions below must be closed using close_box for proper formatting. Otherwise, some of the material printed in the boxes may not be output, or may be formatted incorrectly.

In case of interactive use, the system closes all opened boxes and flushes all pending text (as with the print_newline function) after each phrase. Each phrase is therefore executed in the initial state of the pretty-printer.

Warning: the material output by the following functions is delayed in the pretty-printer queue in order to compute the proper line breaking. Hence, you should not mix calls to the printing functions of the basic I/O system with calls to the functions of this module: this could result in some strange output seemingly unrelated with the evaluation order of printing commands." }, -"descr_cnt": 120.0000, -"compl_descr_cnt": 65.0000 }, { "name": "Printf", -"info": - { "description": "Formatted output functions." }, -"descr_cnt": 11.0000, -"compl_descr_cnt": 11.0000 }, { "name": "Parsing", -"info": - { "description": "The run-time library for parsers generated by ocamlyacc." }, -"descr_cnt": 12.0000, -"compl_descr_cnt": 12.0000 }, { "name": "CamlinternalOO", -"info": - { "description": "Run-time support for objects and classes. All functions in this module are for system use only, not for the casual user." }, -"descr_cnt": 80.0000, -"compl_descr_cnt": 1.0000 }, { "name": "CamlinternalMod", -"info": "", -"descr_cnt": 8.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Std_exit", -"info": "", -"descr_cnt": 1.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Log", -"info": - { "description": "

Loggers

" }, -"descr_cnt": 14.0000, -"compl_descr_cnt": 10.0000 }, { "name": "Oo", -"info": - { "description": "Operations on objects" }, -"descr_cnt": 3.0000, -"compl_descr_cnt": 3.0000 }, { "name": "Bitstring", -"info": - { "description": "Bitstring library." }, -"descr_cnt": 43.0000, -"compl_descr_cnt": 33.0000 }, { "name": "Bitstring_types", -"info": "", -"descr_cnt": 6.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Bitstring_config", -"info": "", -"descr_cnt": 6.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Lwt", -"info": - { "description": "Module Lwt: cooperative light-weight threads." }, -"descr_cnt": 47.0000, -"compl_descr_cnt": 47.0000 }, { "name": "Lwt_util", -"info": - { "description": "Note: This lodule is deprecated. Use Lwt_list and Lwt_pool instead." }, -"descr_cnt": 11.0000, -"compl_descr_cnt": 10.0000 }, { "name": "Lwt_stream", -"info": - { "description": "Data streams" }, -"descr_cnt": 51.0000, -"compl_descr_cnt": 40.0000 }, { "name": "Lwt_sequence", -"info": - { "description": "Mutable sequence of elements" }, -"descr_cnt": 24.0000, -"compl_descr_cnt": 24.0000 }, { "name": "Lwt_mvar", -"info": - { "description": "Mailbox variables" }, -"descr_cnt": 6.0000, -"compl_descr_cnt": 6.0000 }, { "name": "Lwt_mutex", -"info": - { "description": "Cooperative locks for mutual exclusion" }, -"descr_cnt": 8.0000, -"compl_descr_cnt": 8.0000 }, { "name": "Lwt_list", -"info": - { "description": "List helpers" }, -"descr_cnt": 18.0000, -"compl_descr_cnt": 1.0000 }, { "name": "Lwt_pool", -"info": - { "description": "Creating pools (for example pools of connections to a database)." }, -"descr_cnt": 4.0000, -"compl_descr_cnt": 4.0000 }, { "name": "Lwt_condition", -"info": - { "description": "Conditions" }, -"descr_cnt": 6.0000, -"compl_descr_cnt": 6.0000 }, { "name": "Lwt_pqueue", -"info": "", -"descr_cnt": 4.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Lwt_switch", -"info": - { "description": "Lwt switches" }, -"descr_cnt": 9.0000, -"compl_descr_cnt": 9.0000 }, { "name": "Regexp", -"info": - { "description": "This module can be safely open for it only contains a module Re." }, -"descr_cnt": 23.0000, -"compl_descr_cnt": 22.0000 }, { "name": "OS", -"info": - { "description": "Operating System interfaces for UNIX" }, -"descr_cnt": 48.0000, -"compl_descr_cnt": 20.0000 }, { "name": "Net", -"info": "", -"descr_cnt": 106.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Block", -"info": "", -"descr_cnt": 18.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Dns", -"info": - { "description": "create n creates an empty table of initial size n. The table will grow as needed." }, -"descr_cnt": 284.0000, -"compl_descr_cnt": 6.0000 }, { "name": "Http", -"info": - { "description": "Type definitions" }, -"descr_cnt": 145.0000, -"compl_descr_cnt": 45.0000 }, { "name": "Utf8", -"info": "", -"descr_cnt": 11.0000, -"compl_descr_cnt": 0.0000 }, { "name": "Utf16", -"info": - { "description": "UTF-16 support for Ulex. Implementation as described in \"http://www.ietf.org/rfc/rfc2781.txt\"." }, -"descr_cnt": 21.0000, -"compl_descr_cnt": 17.0000 }, { "name": "Ulexing", -"info": - { "description": "Runtime support for lexers generated by ulex. This module is roughly equivalent to the module Lexing from the OCaml standard library, except that its lexbuffers handles Unicode code points (OCaml type: int in the range 0..0x10ffff) instead of bytes (OCaml type: char).

It is possible to have ulex-generated lexers work on a custom implementation for lex buffers. To do this, define a module L which implements the start, next, mark and backtrack functions (See the Internal Interface section below for a specification), and the Error exception. They need not work on a type named lexbuf: you can use the type name you want. Then, just do in your ulex-processed source, before the first lexer specification:

module Ulexing = L

Of course, you'll probably want to define functions like lexeme to be used in the lexers semantic actions." }, -"descr_cnt": 40.0000, -"compl_descr_cnt": 36.0000 }, { "name": "Dyntype", -"info": - { "description": "Dynamic types" }, -"descr_cnt": 28.0000, -"compl_descr_cnt": 27.0000 }, { "name": "Cow", -"info": - { "description": "Streaming XML IO.

A well-formed sequence of signals represents an XML document tree traversal in depth first order (this has nothing to do with XML well-formedness). Input pulls a well-formed sequence of signals from a data source and output pushes a well-formed sequence of signals to a data destination. Functions are provided to easily transform sequences of signals to/from arborescent data structures.

Consult the features and limitations and examples of use.

Version 1.0.2 - daniel.buenzl i@erratique.ch

References.

Tim Bray. The annotated XML Specification, 1998.

Tim Bray et al. Namespaces in XML 1.1 (2nd ed.), 2006.

Basic types and values

" }, -"descr_cnt": 164.0000, -"compl_descr_cnt": 41.0000 } ] \ No newline at end of file