package orsetto
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=151ca6df499bd3de7aa89a4e1627411fbee24c4dea6e0e71ce21f06f181ee654
md5=00393728b481c2bf15919a8202732335
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.
Basic 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.
val value : Cf_type.opaque tThe emitter for opaque values. Raises Invalid_argument if the opaque value was not witnessed with a type compatible with JSON encoding.
Utility
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 witnessed with a type compatible with JSON encoding.