package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type

Reading values from the binary protocol using (mostly) OCaml.

type 'a reader = Bin_prot.Common.buf -> pos_ref:Bin_prot.Common.pos_ref -> 'a

Type of reader functions for the binary protocol. They take a buffer and a reference to a read position, and return the unmarshalled value. The next buffer position after reading in the value will be stored in the position reference.

type ('a, 'b) reader1 = 'a reader -> 'b reader
type ('a, 'b, 'c) reader2 = 'a reader -> ('b, 'c) reader1
type ('a, 'b, 'c, 'd) reader3 = 'a reader -> ('b, 'c, 'd) reader2
val bin_read_unit : unit reader
val bin_read_bool : bool reader
val bin_read_string : string reader
val bin_read_bytes : bytes reader
val bin_read_char : char reader
val bin_read_int : int reader
val bin_read_nat0 : Bin_prot.Nat0.t reader
val bin_read_float : float reader
val bin_read_int32 : int32 reader
val bin_read_int64 : int64 reader
val bin_read_nativeint : nativeint reader
val bin_read_ref : ('a, 'a Stdlib.ref) reader1
val bin_read_lazy : ('a, 'a lazy_t) reader1
val bin_read_option : ('a, 'a option) reader1
val bin_read_pair : ('a, 'b, 'a * 'b) reader2
val bin_read_triple : ('a, 'b, 'c, 'a * 'b * 'c) reader3
val bin_read_list : ('a, 'a list) reader1
val bin_read_array : ('a, 'a array) reader1
val bin_read_hashtbl : ('a, 'b, ('a, 'b) Stdlib.Hashtbl.t) reader2
val bin_read_float32_vec : Bin_prot.Common.vec32 reader
val bin_read_float64_vec : Bin_prot.Common.vec64 reader
val bin_read_vec : Bin_prot.Common.vec reader
val bin_read_float32_mat : Bin_prot.Common.mat32 reader
val bin_read_float64_mat : Bin_prot.Common.mat64 reader
val bin_read_mat : Bin_prot.Common.mat reader
val bin_read_bigstring : Bin_prot.Common.buf reader
val bin_read_floatarray : floatarray reader
val bin_read_float_array : float array reader
  • deprecated [since 2021-09] use ppx_bin_prot with type [float array] or [floatarray] or the 'floatarray' functions
val bin_read_variant_int : int reader
val bin_read_int_8bit : int reader
val bin_read_int_16bit : int reader
val bin_read_int_32bit : int reader
val bin_read_int_64bit : int reader
val bin_read_int64_bits : int64 reader
val bin_read_network16_int : int reader
val bin_read_network32_int : int reader
val bin_read_network32_int32 : int32 reader
val bin_read_network64_int : int reader
val bin_read_network64_int64 : int64 reader
val bin_read_md5 : Md5_lib.t reader
val bin_read_list_with_max_len : max_len:int -> ('a, 'a list) reader1

Fail early if the list is larger than max_len.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct