Index of values


A
add_anon [Jsont]
add_anon a name o v is o except its name anonymous member is v.
anon [Jsont]
anon o c declares that all unknown object members of o have a JSON value c.
anon_names [Jsont]
anon_names a o is o's list of anonymous member names.
anonv [Jsont]
anonv a name v is an a anonymous member named name with value v.
array [Jsont]
array elt is a JSON array whose elements are JSON values elt.
array_array [Jsont]
array_array is like Jsont.array but the OCaml representation is an array.

B
bool [Jsont]
bool is a JSON boolean.

D
decode [Jsont]
decode d is: `Await if d's backend decoder is non-blocking and needs a refill., `Error e if an error occured. If the client is interested in a best-effort decoding it can still continue to decode., `Ok v when the end of input was reached and the value is decoded. In case of error this value may be partially defined by codec default values.
decoder [Jsont_jsoo]
decoder src is a decoder that reads from src.
decoder [Jsont]
decoder unsafe loc mem_dups d v is a decoder for a value described v using the backend decoder d.
decoder_decoder [Jsont]
decoder_decoder d is d's backend decoder.
decoder_src [Jsont_jsoo]
decoder_src d is d's source.
default [Jsont]
default c is c's default value.

E
encode [Jsont]
encode e encodes the value in e returns `Partial if e's native encoder is non-blocking an needs more output storage., `Ok when the encoder finished to encode the value.
encoder [Jsont_jsoo]
encoder () is a new encoder.
encoder [Jsont]
encoder e c v is an encoder that encodes v as described by c using the native encoder e.
encoder_dst [Jsont_jsoo]
encoder_dst e is the result of the Jsont.encodeing process.
encoder_encoder [Jsont]
encoder_encoder e is e's backend encoder.
enum [Jsont]
enum default enums maps finite sets of JSON strings to values of type 'a.
error_to_string [Jsont]
error_to_string e is e as an unspecified string.

F
find_anon [Jsont]
find_anon a name o is o's name anonymous member value.
find_anon_def [Jsont]
find_anon_def is like Jsont.find_anon but with location information.
float [Jsont]
float is a JSON number.

G
get [Jsont]
get m o is o's m member value.
get_anon [Jsont]
get_anon is like Jsont.find_anon but
get_anon_def [Jsont]
get_anon_def is like Jsont.get_anon but with location information.
get_def [Jsont]
get_def is like Jsont.get but with location information.

I
int [Jsont]
int is a JSON number as an integer.
int_strict [Jsont]
int_strict is like Jsont.int but errors on a JSON number with a fractional part.
invalid_def [Jsont]
invalid_def v is (invalid_loc, v)
invalid_loc [Jsont]
invalid_loc is an invalid location.
is_invalid_loc [Jsont]
is_invalid_loc l is true iff l is Jsont.invalid_loc.

J
json [Jsont]
json is any JSON value using a generic JSON text representation.

M
mem [Jsont]
mem opt o name c declares in o an object member named name with JSON value c.
mem_match [Jsont]
mem_match opt o m name select is like Jsont.mem, except its value at encoding and decoding time is determined by select v where v is the value of the member m in the JSON object.
mem_opt [Jsont]
mem_opt o name c is mem o name ~opt:`Yes_rem (some c).
memv [Jsont]
memv m v is member m with value v.

N
nat_string [Jsont]
nat_string is like Jsont.string but the OCaml representation is a backend native string value.
nat_string_of_string [Jsont]
nat_string_of_string s is a native string from the OCaml string s.
nat_string_to_string [Jsont]
nat_string_to_string s is an OCaml string from the native string s.
new_obj [Jsont]
new_obj c memvs is a new object described by c with members memvs.
null [Jsont]
null is the JSON null value.
nullable [Jsont]
nullable c is either the JSON value c or JSON null.

O
obj [Jsont]
obj seal o is a codec for a JSON object described by o.
objc [Jsont]
objc kind () is a new object codec.

R
rem_anon [Jsont]
rem_anon a name o is o except its name anonymous member is deleted.

S
set [Jsont]
set m o v is o except o's m member value is v.
some [Jsont]
some c is the JSON value c but wrapped by Some.
soup [Jsont]
soup is any JSON value.
string [Jsont]
string is a JSON string.

T
type_match [Jsont]
type_match default dec enc is a JSON value codec by: On decoding: dec typ where typ is determined according to the type found in the data. If `Error is returned on a given data type the error will be returned by the decoder. If `Ok d is, d is used to decode the value. You must make sure that d does actually describe the given datatype (i.e. it would be wrong to return Jsont.int on `Bool)., On encoding: enc v where v is the member value. default is its default value.

U
undef [Jsont]
undef v is snd v.

V
view [Jsont]
view view c is the JSON value c whose OCaml representation is transformed by value codec view.

W
with_default [Jsont]
with_default v c is c with default value v.