package orsetto
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=585297372d7f6cfb830214e9ef22d6d072a39b2a1591ef90f1ee2bcfe144cad3
md5=6bb6a7ba88bf2c7595a0b332921e60b4
doc/orsetto.json/Json_emit/index.html
Module Json_emit
JavaScript Object Notation (JSON) output formatter.
Overview
Specialization of
f_emit
to output texts in the JSON format. Combinators are provided for the basic JSON types to be used for directly emitting application data as JSON text. Additional conveniences are provided for emitting encapsulated JSON values as text.
Type
type 'a t = private 'a Cf_emit.To_formatter.tThe type of JSON emitters.
val null : unit tThe emitter for the JSON null literal
val boolean : bool tThe emitter for JSON boolean values.
val integer : int tThe emitter for integers as JSON numeric values.
val float : float tThe emitter for floats as JSON numeric values.
val string : Ucs_text.t tThe emitter for Unicode texts as JSON string literals.
Use array f to make an emitter for values represented as JSON arrays. Applies the emitted value to f and elaborates the returned sequence of sealed emitters as a JSON array.
val objval : ('a -> (Ucs_text.t * unit t) Seq.t) -> 'a tUse objval f to make an emitter for values represented as JSON objects. Applies the emitted value to f and elaborates the returned sequence of key/value pairs as a JSON object. The value of each field is a sealed emitter.
JSON Values
val value : Cf_type.opaque tThe emitter for opaque values. Raises Invalid_argument if the opaque value was not witnesded with a type compatible with JSON encoding.
val to_text : Cf_type.opaque -> Ucs_text.tUse to_text v to format v as a Unicode text. Raises Invalid_argument if v was not witnesded with a type compatible with JSON encoding.