package records

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

package records

records
- Polid
- Record
  - Field
  - Polid
  - Safe
    
    LAYOUT
  - Type
  - Unsafe
  - Util
- Type

Legend:
Library
Module
Module type
Parameter
Class
Class type

Type converters

type 'a t

How to convert a type to and from JSON.

val name : 'a t -> string

val of_yojson : 'a t -> Yojson.Safe.json -> [ `Ok of 'a | `Error of string ]

val to_yojson : 'a t -> 'a -> Yojson.Safe.json

val make : 
  name:string ->
  to_yojson:('a -> Yojson.Safe.json) ->
  of_yojson:(Yojson.Safe.json -> [ `Ok of 'a | `Error of string ]) ->
  unit ->
  'a t

Declare a new type.

val make_string : 
  name:string ->
  to_string:('a -> string) ->
  of_string:(string -> [ `Ok of 'a | `Error of string ]) ->
  unit ->
  'a t

Declare a new type that marshal/unmarshal to strings.

val exn : exn t

How to represent exceptions.

exception UnserializedException of string

Raised by exn.of_json

val unit : unit t

How to represent unit.

val string : string t

How to represent string.

val int : int t

How to represent int.

val list : 'a t -> 'a list t

Build a representation of a list.

val product_2 : string -> 'a t -> string -> 'b t -> ('a * 'b) t

Build a representation of a couple. The labels identify the elements, not their types.

val view : 
  name:string ->
  read:('a -> [ `Ok of 'b | `Error of string ]) ->
  write:('b -> 'a) ->
  'a t ->
  'b t

Build a 'b type which has the same JSON encoding as the 'a type from conversion functions read and write.