Module Topkg_codec

Topkg interprocess communication codec.

See Topkg.Private.Codec for documentation.

Codec

type error =
  1. | Corrupted of string * string
  2. | Version of int * int
val pp_error : Stdlib.Format.formatter -> error -> unit
exception Error of error
val err : kind:string -> string -> 'a
type 'a t
val v : kind:string -> enc:('a -> string) -> dec:(string -> 'a) -> 'a t
val kind : 'a t -> string
val enc : 'a t -> 'a -> string
val dec : 'a t -> string -> 'a
val dec_result : 'a t -> string -> 'a Topkg_result.result
val with_kind : string -> 'a t -> 'a t
val write : Topkg_fpath.t -> 'a t -> 'a -> unit Topkg_result.result
val read : Topkg_fpath.t -> 'a t -> 'a Topkg_result.result
val unit : unit t
val const : 'a -> 'a t
val bool : bool t
val int : int t
val string : string t
val option : 'a t -> 'a option t
val result : ok:'a t -> error:'b t -> ('a, 'b) Topkg_result.r t
val list : 'a t -> 'a list t
val pair : 'a t -> 'b t -> ('a * 'b) t
val t2 : 'a t -> 'b t -> ('a * 'b) t
val t3 : 'a t -> 'b t -> 'c t -> ('a * 'b * 'c) t
val t4 : 'a t -> 'b t -> 'c t -> 'd t -> ('a * 'b * 'c * 'd) t
val t5 : 'a t -> 'b t -> 'c t -> 'd t -> 'e t -> ('a * 'b * 'c * 'd * 'e) t
val alt : kind:string -> ('a -> int) -> 'a t array -> 'a t
val version : int -> 'a t -> 'a t
val view : ?kind:string -> (('a -> 'b) * ('b -> 'a)) -> 'b t -> 'a t
val msg : [ `Msg of string ] t
val result_error_msg : 'a t -> 'a Topkg_result.result t
val fpath : Topkg_fpath.t t
val cmd : Topkg_cmd.t t