1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
|
(* File: write_ml.mli
Copyright (C) 2007-
Jane Street Holding, LLC
Author: Markus Mottl
email: mmottl\@janestreet.com
WWW: http://www.janestreet.com/ocaml
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
(** Write_ml: writing values to the binary protocol using (mostly) OCaml. *)
open Bigarray
open Common
type 'a writer = buf -> pos : pos -> 'a -> pos
(** Type of writer functions for the binary protocol. They take a buffer,
a write position and a value, and return the next position after
writing out the value. *)
type ('a, 'b) writer1 = 'a writer -> 'b writer
type ('a, 'b, 'c) writer2 = 'a writer -> ('b, 'c) writer1
type ('a, 'b, 'c, 'd) writer3 = 'a writer -> ('b, 'c, 'd) writer2
val bin_write_unit : unit writer
val bin_write_bool : bool writer
val bin_write_string : string writer
val bin_write_char : char writer
val bin_write_int : int writer
val bin_write_nat0 : Nat0.t writer
val bin_write_float : float writer
val bin_write_int32 : int32 writer
val bin_write_int64 : int64 writer
val bin_write_nativeint : nativeint writer
val bin_write_ref : ('a, 'a ref) writer1
val bin_write_lazy : ('a, 'a lazy_t) writer1
val bin_write_option : ('a, 'a option) writer1
val bin_write_pair : ('a, 'b, 'a * 'b) writer2
val bin_write_triple : ('a, 'b, 'c, 'a * 'b * 'c) writer3
val bin_write_list : ('a, 'a list) writer1
val bin_write_array : ('a, 'a array) writer1
val bin_write_hashtbl : ('a, 'b, ('a, 'b) Hashtbl.t) writer2
val bin_write_float32_vec : vec32 writer
val bin_write_float64_vec : vec64 writer
val bin_write_vec : vec writer
val bin_write_float32_mat : mat32 writer
val bin_write_float64_mat : mat64 writer
val bin_write_mat : mat writer
val bin_write_bigstring : buf writer
val bin_write_float_array : float array writer
val bin_write_variant_tag : [> ] writer
(** [bin_write_variant_tag] writes out the exact bit representation of
the variant tag of the given value (= 32 bits). *)
val bin_write_int_8bit : int writer
(** [bin_write_int_8bit] writes out the exact bit representation of
the given [int] value using the lower 8 bits. *)
val bin_write_int_16bit : int writer
(** [bin_write_int_16bit] writes out the exact bit representation of
the given [int] value using the lower 16 bits. *)
val bin_write_int_32bit : int writer
(** [bin_write_int_32bit] writes out the exact bit representation of
the given [int] value using the lower 32 bits. *)
val bin_write_int_64bit : int writer
(** [bin_write_int_64bit] writes out the exact bit representation of
the given [int] value using all 64 bits. *)
val bin_write_int64_bits : int64 writer
(** [bin_write_int64_bits] writes out the exact bit representation of
the given [int64] value. *)
val bin_write_network16_int : int writer
(** [bin_write_network16_int] writes out an integer in 16bit network
byte order (= big-endian). *)
val bin_write_network32_int : int writer
(** [bin_write_network32_int] writes out an integer in 32bit network
byte order (= big-endian). *)
val bin_write_network32_int32 : int32 writer
(** [bin_write_network32_int32] writes out a 32bit integer in 32bit
network byte order (= big-endian). *)
val bin_write_network64_int : int writer
(** [bin_write_network64_int] writes out an integer in 64bit network
byte order (= big-endian). *)
val bin_write_network64_int64 : int64 writer
(** [bin_write_network64_int64] writes out a 64bit integer in 64bit
network byte order (= big-endian). *)
val bin_write_array_no_length : ('a, 'a array) writer1
(** [bin_write_array_no_length] writes out all values in the given array
without writing out its length. *)
|