package bin_prot

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Buffers
Errors and exceptions
Bigarrays
Miscellaneous
NOTE: unsafe functions!!!

package bin_prot

bin_prot
- Library bin_prot
  - Bin_prot
    
    Binable
    
    S_only_functions
    
    S_local_only_functions
    
    S
    
    S_local
    
    S1
    
    S_local1
    
    S2
    
    S_local2
    
    S3
    
    S_local3
    
    Minimal
    
    S
    
    S_local
    
    S1
    
    S_local1
    
    S2
    
    S_local2
    
    S3
    
    S_local3
    
    Blob
    
    Opaque
    
    Bigstring
    
    String
    
    Ignored
    
    Common
    
    ReadError
    
    Md5
    
    Stable
    
    V1
    
    Nat0
    
    Read
    
    Shape
    
    Tid
    
    Vid
    
    Location
    
    Uuid
    
    Stable
    
    Digest
    
    Expert
    
    Canonical
    
    For_typerep
    
    Size
    
    Maximum
    
    Minimum
    
    Std
    
    Maximum
    
    Minimum
    
    Type_class
    
    S1
    
    S2
    
    S3
    
    Utils
    
    Of_minimal
    
    Of_minimal1
    
    Make_binable_with_uuid_spec
    
    Binable
    
    Make_binable1_with_uuid_spec
    
    Binable
    
    Make_binable2_with_uuid_spec
    
    Binable
    
    Make_binable3_with_uuid_spec
    
    Binable
    
    Make_binable_with_uuid
    
    Make_binable1_with_uuid
    
    Make_binable2_with_uuid
    
    Make_binable3_with_uuid
    
    Make_binable_without_uuid_spec
    
    Binable
    
    Make_binable1_without_uuid_spec
    
    Binable
    
    Make_binable2_without_uuid_spec
    
    Binable
    
    Make_binable3_without_uuid_spec
    
    Binable
    
    Make_binable_without_uuid
    
    Make_binable1_without_uuid
    
    Make_binable2_without_uuid
    
    Make_binable3_without_uuid
    
    Make_iterable_binable_spec
    
    Make_iterable_binable1_spec
    
    Make_iterable_binable2_spec
    
    Make_iterable_binable3_spec
    
    Make_iterable_binable
    
    Make_iterable_binable1
    
    Make_iterable_binable2
    
    Make_iterable_binable3
    
    Write
- Library bin_prot.shape
  - Bin_shape
    
    Tid
    
    Vid
    
    Location
    
    Uuid
    
    Stable
    
    V1
    
    Digest
    
    Expert
    
    Sorted_table
    
    Canonical_exp_constructor
    
    Canonical
    
    Exp1
    
    Canonical
    
    Exp
    
    Def
    
    Create
    
    For_typerep
- Library bin_prot.xen
  - Bin_prot_xen
- Sources
  - bin_prot
    
    bin_prot.ml
    
    bin_prot__.ml
    
    binable.ml
    
    blob.ml
    
    common.ml
    
    md5.ml
    
    nat0.ml
    
    read.ml
    
    read_intf.ml
    
    shape.ml
    
    size.ml
    
    size_intf.ml
    
    std.ml
    
    type_class.ml
    
    type_class_intf.ml
    
    utils.ml
    
    utils_intf.ml
    
    write.ml
    
    write_intf.ml
  - bin_prot.shape
    
    bin_shape.ml
  - bin_prot.xen
    
    bin_prot_xen.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Bin_prot.Common`Source

Common definitions used by binary protocol converters

Buffers

Sourcetype pos = int

Position within buffers

Sourcetype pos_ref = pos ref

Reference to a position within buffers

Source

type buf =
  (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t

Buffers

Sourceval create_buf : int -> buf

create_buf n creates a buffer of size n.

Sourceval buf_len : buf -> int

buf_len buf returns the length of buf.

Sourceval assert_pos : pos -> unit

assert_pos pos

raises Invalid_argument
if position pos is negative.

Sourceval check_pos : buf -> pos -> unit

check_pos buf pos

raises Buffer_short
if position pos is past the end of buffer buf.

Sourceval check_next : buf -> pos -> unit

check_next buf pos

raises Buffer_short
if the next position after pos is past the end of buffer buf.

Sourceval safe_get_pos : buf -> pos_ref -> pos

safe_get_pos buf pos_ref

returns
the position referenced by pos_ref within buffer buf.
@raise Buffer_short
if the position is past the end of the buffer buf.

Source

val blit_string_buf : 
  ?src_pos:int ->
  string ->
  ?dst_pos:int ->
  buf ->
  len:int ->
  unit

blit_string_buf ?src_pos src ?dst_pos dst ~len blits len bytes of the source string src starting at position src_pos to buffer dst starting at position dst_pos.

raises Invalid_argument
if the designated ranges are invalid.

Source

val blit_bytes_buf : 
  ?src_pos:int ->
  bytes ->
  ?dst_pos:int ->
  buf ->
  len:int ->
  unit

blit_bytes_buf ?src_pos src ?dst_pos dst ~len blits len bytes of the source byte sequence src starting at position src_pos to buffer dst starting at position dst_pos.

raises Invalid_argument
if the designated ranges are invalid.

Source

val blit_buf_string : 
  ?src_pos:int ->
  buf ->
  ?dst_pos:int ->
  bytes ->
  len:int ->
  unit

blit_buf_string ?src_pos src ?dst_pos dst ~len blits len bytes of the source buffer src starting at position src_pos to string dst starting at position dst_pos.

raises Invalid_argument
if the designated ranges are invalid.

Source

val blit_buf_bytes : 
  ?src_pos:int ->
  buf ->
  ?dst_pos:int ->
  bytes ->
  len:int ->
  unit

blit_buf_bytes ?src_pos src ?dst_pos dst ~len blits len bytes of the source buffer src starting at position src_pos to byte sequence dst starting at position dst_pos.

raises Invalid_argument
if the designated ranges are invalid.

Source

val blit_buf : 
  ?src_pos:int ->
  src:buf ->
  ?dst_pos:int ->
  dst:buf ->
  int ->
  unit

blit_buf ?src_pos ~src ?dst_pos ~dst len blits len bytes of the source buffer src starting at position src_pos to destination buffer dst starting at position dst_pos.

raises Invalid_argument
if the designated ranges are invalid.

Errors and exceptions

Sourceexception Buffer_short

Buffer too short for read/write operation

Sourceexception No_variant_match

Used internally for backtracking

Sourcemodule ReadError : sig ... end

Sourceexception Read_error of ReadError.t * pos

ReadError (err, err_pos)

Sourceexception Poly_rec_write of string

PolyRecWrite type gets raised when the user attempts to write or estimate the size of a value of a type that is bound through a polymorphic record field in type definition type.

Sourceexception Empty_type of string

EmptyType gets raised when the user attempts to write or estimate the size of a value of an empty type, which would not make sense.

Sourceval raise_read_error : ReadError.t -> pos -> 'a

raise_read_error err pos

Sourceval raise_variant_wrong_type : string -> pos -> 'a

raise_variant_wrong_type name pos

Sourceval raise_concurrent_modification : string -> 'a

raise_concurrent_modification loc

raises Failure
if a binary writer detects a concurrent change to the underlying data structure.

Sourceval array_bound_error : unit -> 'a

array_bound_error ()

Bigarrays

Source

type vec32 =
  (float, Bigarray.float32_elt, Bigarray.fortran_layout) Bigarray.Array1.t

Source

type vec64 =
  (float, Bigarray.float64_elt, Bigarray.fortran_layout) Bigarray.Array1.t

Sourcetype vec = vec64

Source

type mat32 =
  (float, Bigarray.float32_elt, Bigarray.fortran_layout) Bigarray.Array2.t

Source

type mat64 =
  (float, Bigarray.float64_elt, Bigarray.fortran_layout) Bigarray.Array2.t

Sourcetype mat = mat64

Miscellaneous

Sourceval copy_htbl_list : ('a, 'b) Hashtbl.t -> ('a * 'b) list -> ('a, 'b) Hashtbl.t

copy_htbl_list htbl lst adds all (key, value) pairs in lst to hash table htbl.

NOTE: unsafe functions!!!

Source

val unsafe_blit_buf : 
  src_pos:int ->
  src:buf ->
  dst_pos:int ->
  dst:buf ->
  len:int ->
  unit

Source

val unsafe_blit_string_buf : 
  src_pos:int ->
  string ->
  dst_pos:int ->
  buf ->
  len:int ->
  unit

Source

val unsafe_blit_bytes_buf : 
  src_pos:int ->
  bytes ->
  dst_pos:int ->
  buf ->
  len:int ->
  unit

Source

val unsafe_blit_buf_string : 
  src_pos:int ->
  buf ->
  dst_pos:int ->
  bytes ->
  len:int ->
  unit

Source

val unsafe_blit_buf_bytes : 
  src_pos:int ->
  buf ->
  dst_pos:int ->
  bytes ->
  len:int ->
  unit

Source

val unsafe_blit_float_array_buf : 
  src_pos:int ->
  float array ->
  dst_pos:int ->
  buf ->
  len:int ->
  unit

Source

val unsafe_blit_buf_float_array : 
  src_pos:int ->
  buf ->
  dst_pos:int ->
  float array ->
  len:int ->
  unit

Source

val unsafe_blit_floatarray_buf : 
  src_pos:int ->
  floatarray ->
  dst_pos:int ->
  buf ->
  len:int ->
  unit

Source

val unsafe_blit_buf_floatarray : 
  src_pos:int ->
  buf ->
  dst_pos:int ->
  floatarray ->
  len:int ->
  unit

Sourceval (+) : int -> int -> int

package bin_prot

Module Bin_prot.CommonSource

Buffers

Errors and exceptions

Bigarrays

Miscellaneous

NOTE: unsafe functions!!!

Module `Bin_prot.Common`Source