Module Deriving_Json

module Deriving_Json: sig .. end

Typesafe IO (based on the deriving library).
See also

type 'a t

The type of JSON parser/printer for value of type 'a.

val to_string : 'a t -> 'a -> string

to_string Json.t<ty> v marshal the v of type ty to a JSON string.

val from_string : 'a t -> string -> 'a

from_string Json.t<ty> s safely unmarshal the JSON s into an OCaml value of type ty. Throws Failure if the received value isn't the javascript representation of a value of type ty.

module type Json = sig .. end

The signature of the JSON class.

Convertion

val convert : 'a t -> ('a -> 'b) -> ('b -> 'a) -> 'b t

convert (t : 'a t) (from_ : 'a -> 'b) (to_ : 'b -> 'a) generate a JSON parser/printer for value of type 'b using the parser/printer of type 'a provided by t

module type Json_converter = sig .. end

The signature of the Converter class.

module Convert (J : Json_converter) : Json  with type a = J.b

Generate a JSON class from a Converter

Examples

Parse and serialize a map as if it was an array of tuple.

(* My map module *)

module StringMap = Map.Make(String)



(* Use deriving_json syntax to generate the JSON class for the array of tuple *)

type 'a t = (string * 'a) array deriving (Json)



(* generate the JSON class for StringMap *)

module Json_string_map_t(A : Deriving_Json.Json) : Deriving_Json.Json with type a = A.a StringMap.t = struct

  module S = Json_t(A)

  include Deriving_Json.Convert(struct

      type a = A.a t

      type b = A.a StringMap.t

      let t = S.t

      let to_ : b -> A.a t = fun a -> Array.of_list (StringMap.bindings a)

      let from_ : A.a t -> b = fun l ->

        Array.fold_left

          (fun map (x,v) -> StringMap.add x v map)

          StringMap.empty

          l

    end)

end

You can then ask the syntax extension to use the JSON class Json_string_map_t for StringMap.t by registering an alias

Pa_deriving_Json.register_predefs ["StringMap";"t"] ["string_map_t"]

Examples

Parse and serialize a map as if it was an array of tuple.

(* My map module *)

module StringMap = Map.Make(String)



(* Use deriving_json syntax to generate the JSON class for the array of tuple *)

type 'a t = (string * 'a) array deriving (Json)



(* generate the JSON class for StringMap *)

module Json_string_map_t(A : Deriving_Json.Json) : Deriving_Json.Json with type a = A.a StringMap.t = struct

  module S = Json_t(A)

  include Deriving_Json.Convert(struct

      type a = A.a t

      type b = A.a StringMap.t

      let t = S.t

      let to_ : b -> A.a t = fun a -> Array.of_list (StringMap.bindings a)

      let from_ : A.a t -> b = fun l ->

        Array.fold_left

          (fun map (x,v) -> StringMap.add x v map)

          StringMap.empty

          l

    end)

end

You can then ask the syntax extension to use the JSON class Json_string_map_t for StringMap.t by registering an alias

Pa_deriving_Json.register_predefs ["StringMap";"t"] ["string_map_t"]

Deriver

module type Json_min = sig .. end

module type Json_min' = sig .. end

module type Json_min'' = sig .. end

module Defaults (J : Json_min) : Json  with type a = J.a

module Defaults' (J : Json_min') : Json  with type a = J.a

module Defaults'' (J : Json_min'') : Json  with type a = J.a

module Json_char: Json  with type a = char

module Json_bool: Json  with type a = bool

module Json_unit: Json  with type a = unit

module Json_int: Json  with type a = int

module Json_int32: Json  with type a = int32

module Json_int64: Json  with type a = int64

module Json_nativeint: Json  with type a = nativeint

module Json_float: Json  with type a = float

module Json_string: Json  with type a = string

module Json_list (A : Json) : Json  with type a = A.a list

module Json_ref (A : Json) : Json  with type a = A.a ref

module Json_option (A : Json) : Json  with type a = A.a option

module Json_array (A : Json) : Json  with type a = A.a array