package ppx_protocol_conv
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=994362c2185d12f732e522e1e457b7de67745e594b898368c878424e93f84587
sha512=237b236a257f35ad671194f6ee0690dfc85eef9b088a928e7b0582b23b5acc19b6727318be6b7abfa0f6c1052047b820e7a0345d8cadb3c0280e18dc3da6e453
doc/ppx_protocol_conv.runtime/Protocol_conv/Runtime/Helper/index.html
Module Runtime.Helper
Source
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.t
Map 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 ->
'b
to_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.t
Map fields names of a Record_out
structure
val of_record :
'a 't. omit_default:bool ->
't serialize_record ->
('t, 'a, 't) Record_out.t ->
'a
of_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 list
Map field names in all inline records of the spec