package jsont

  1. Overview
  2. Docs
Declarative JSON data manipulation for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (2)

Authors

  1. T
    The jsont programmers

Maintainers

  1. Daniel Bünzli

Sources

jsont-0.2.0.tbz
sha512=6206f73a66cb170b560a72e58f70b9fb2c20397b9ab819dceba49b6602b9b79e47ba307e6910e61ca4694555c66fdcd7a17490afb99548e8f43845a5a88913e7

doc/jsont/Jsont/Json/index.html

Module Jsont.JsonSource

Generic JSON values.

JSON values

Sourcetype 'a jsont := 'a t
Sourcetype 'a cons = ?meta:Meta.t -> 'a -> json

The type for constructing JSON values from an OCaml value of type 'a. meta defaults to Meta.none.

Sourcetype t = json

See Jsont.json.

Sourceval meta : json -> Meta.t

meta v is the metadata of value v.

Sourceval set_meta : Meta.t -> json -> json

set_meta m v replaces v's meta with m.

Sourceval copy_layout : json -> dst:json -> json

copy_layout src ~dst copies the layout of src and sets it on dst using Meta.copy_ws.

Sourceval sort : json -> Sort.t

sort v is the sort of value v.

Sourceval zero : json cons

zero j is a stub value of the sort value of j. The stub value is the “natural” zero: null, false, 0, empty string, empty array, empty object.

Sourceval equal : json -> json -> bool

equal j0 j1 is compare j0 j1 = 0.

Sourceval compare : json -> json -> int

compare j0 j1 is a total order on JSON values:

  • Floating point values are compared with Float.compare, this means NaN values are equal.
  • Strings are compared byte wise.
  • Objects members are sorted before being compared.
  • Meta.t values are ignored.
Sourceval pp : t fmt

See Jsont.pp_json.

Nulls and options

Sourceval null : unit cons

null is Null (unit, meta).

Sourceval option : 'a cons -> 'a option cons

option c constructs Some v values with c v and None ones with null.

Booleans

Sourceval bool : bool cons

bool b is Bool (b, meta).

Numbers

Sourceval number : float cons

number n is Number (n, meta).

Sourceval any_float : float cons

any_float v is number v if Float.is_finite v is true and string (Float.to_string v) otherwise. See Jsont.any_float.

Sourceval int32 : int32 cons

int32 is i as a JSON number.

Sourceval int64 : int64 cons

int64 i is i as a JSON number or a JSON string if not in the range [-253;253]. See also int64_as_string.

Sourceval int64_as_string : int64 cons

int64_as_string i is i as a JSON string. See also int64.

Sourceval int : int cons

int is i as a JSON number or a JSON string if not in the range [-253;253]. See also int_as_string.

Sourceval int_as_string : int cons

int_as_string i is i as a JSON string. See also int.

Strings

Sourceval string : string cons

string s is String (s, meta).

Arrays

Sourceval list : json list cons

list l is Array (l, meta).

Sourceval array : json array cons

array l is Array (Array.to_list a, meta). See also list.

Objects

Sourceval name : ?meta:Meta.t -> string -> name

name ?meta n is (n, meta). meta defaults to Meta.none.

Sourceval mem : name -> json -> mem

mem n v is (n, v). meta defaults to Meta.none.

Sourceval object' : object' cons

object o is Object (o, meta).

Sourceval find_mem : string -> object' -> mem option

find_mem n ms find the first member whose name matches n in ms.

Sourceval find_mem' : name -> object' -> mem option

find_mem n ms is find_mem (fst n) ms.

Sourceval object_names : object' -> string list

object_names ms are the names of ms.

Sourceval object_names' : object' -> name list

object_names ms are the names of ms.

Decode

Sourceval decode : 'a jsont -> json -> ('a, string) result

decode t j decodes a value from the generic JSON j according to type t.

Sourceval decode' : 'a jsont -> json -> ('a, Error.t) result

decode' is like decode but preserves the error structure.

Encode

Sourceval encode : 'a jsont -> 'a -> (json, string) result

encode t v encodes a generic JSON value for v according to type t.

Sourceval encode' : 'a jsont -> 'a -> (json, Error.t) result

encode' is like encode but preserves the error structure.

Recode

Sourceval recode : 'a jsont -> json -> (json, string) result

recode t v decodes v with t and encodes it with t.

Sourceval recode' : 'a jsont -> json -> (json, Error.t) result

recode' is like recode but preserves the error structure.

Sourceval update : 'a jsont -> json -> json

update is like recode but raises Jsont.Error.

Errors

Sourceval error_sort : exp:Sort.t -> json -> 'a

error_sort ~exp fnd errors when sort exp was expected but generic JSON fnd was found.

Sourceval error_type : 'a jsont -> json -> 'a

error_type t fnd errors when the type expected by t does not match fnd.