package ppx_protocol_conv
Install
Dune Dependency
Authors
Maintainers
Sources
md5=e71abaeffcf8596d49a04acb27e00f24
sha512=b0322030fa81af86cbe7b8b502c743768daf60c73f0219d4ce12b175c9612b1fc34bb10bf2dbbcdf9743ab321157e2ffdd8e3160f92372c7b59785ae87fbbebd
doc/ppx_protocol_conv.runtime/Protocol_conv/Runtime/Helper/index.html
Module Runtime.HelperSource
Module contains helper function for serializing and deserializing tuples, records and variants. Deserialization functions may raise Helper.Protocol exception. It is recommended that the calling functions convert this exception into a Driver.Protocol_exception
Tail recursive version of map
Excpetion raised if the type could not be serialized
val map_record_in :
't 'a 'b. (string -> string) ->
('t, 'a, 'b) Record_in.t ->
('t, 'a, 'b) Record_in.tMap fields names of a Record_in structure
val to_record :
't 'constr 'b. ?strict:bool ->
('t, 'constr, 'b) Record_in.t ->
'constr ->
(string * 't) list ->
'bto_recordspecconstructorts returns the constructed value. ts is a associative array (string * t) list, mapping fields to the deserialized value t if strict is true, an error will be raised if input contains an unknown field. If dublicate fields are found in the input, an error is raised
val map_record_out :
't 'a. (string -> string) ->
('t, 'a, 't) Record_out.t ->
('t, 'a, 't) Record_out.tMap fields names of a Record_out structure
val of_record :
'a 't. omit_default:bool ->
't serialize_record ->
('t, 'a, 't) Record_out.t ->
'aof_recordmap_fspec produces a valid deserialisation function for a record type The map_f function is called to produce the serialized result from a field_name, t association list. If omit_default is true, then default values are omitted from the output
to_tuplespectlist produces a tuple from the serialized values in tlist
of_variantspecv serializes v and returns the serialized values as a list or map
val map_constructor_names :
(string -> string) ->
('t, 'a) Variant_in.t list ->
('t, 'a) Variant_in.t listMap field names in all inline records of the spec