cconv 0.2 · OCaml Package

type 'a target = {

unit : 'a;
bool : bool -> 'a;
float : float -> 'a;
int : int -> 'a;
string : string -> 'a;
list : 'a list -> 'a;
option : 'a option -> 'a;
record : (string * 'a) list -> 'a;
tuple : 'a list -> 'a;
sum : string -> 'a list -> 'a;

}

val string_target : string target

Print values. Caution, inefficient! Should be used for debugging only

type -'src encoder = {

emit : 'into. 'into target -> 'src -> 'into;

}

A way to encode values of type 'src into any serialization format

val unit : unit encoder

val bool : bool encoder

val float : float encoder

val int : int encoder

val string : string encoder

val list : 'a encoder -> 'a list encoder

val map : ('a -> 'b) -> 'b encoder -> 'a encoder

val array : 'a encoder -> 'a array encoder

val sequence : 'a encoder -> 'a sequence encoder

type hlist =

| HNil : hlist
| HCons : 'a encoder * 'a * hlist -> hlist

Heterogeneous List

val hnil : hlist

val hcons : 'a encoder -> 'a -> hlist -> hlist

val (@::) : ('a encoder * 'a) -> hlist -> hlist

Composite Types

type record_fields =

| RecordEnd : record_fields
(*
Empty record
*)
| RecordField : string * 'a encoder * 'a * record_fields -> record_fields

val record_end : record_fields

val field : string -> 'a encoder -> 'a -> record_fields -> record_fields

val (@->) : (string * 'a encoder * 'a) -> record_fields -> record_fields

Infix constructor for record fields. Example:

type point = {x:int; y:int; c:string};;
let enc_point = record
  (fun {x;y;c} ->
     ("x", int, x) @->
     ("y", int, y) @->
     ("c", string, c) @->
     record_end
  ) ;;

val record : ('r -> record_fields) -> 'r encoder

val record_fix : ('r encoder -> 'r -> record_fields) -> 'r encoder

val tuple : ('a -> hlist) -> 'a encoder

General encoding of tuples

val pair : 'a encoder -> 'b encoder -> ('a * 'b) encoder

val triple : 'a encoder -> 'b encoder -> 'c encoder -> ('a * 'b * 'c) encoder

val quad : 
  'a encoder ->
  'b encoder ->
  'c encoder ->
  'd encoder ->
  ('a * 'b * 'c * 'd) encoder

val sum : ('a -> string * hlist) -> 'a encoder

val sum0 : ('a -> string) -> 'a encoder

Constant sums

val sum_fix : ('a encoder -> 'a -> string * hlist) -> 'a encoder

val option : 'a encoder -> 'a option encoder

package cconv

Composite Types