Library
Module
Module type
Parameter
Class
Class type
This module supports standard JSON nodes only, i.e. no special syntax for variants or tuples as supported by Yojson.Safe
. Arbitrary integers are not supported as they must all fit within the standard OCaml int type (31 or 63 bits depending on the platform).
The main advantage of this module is its simplicity.
type t = [
| `Null
| `Bool of bool
| `Int of int
| `Float of float
| `String of string
| `Assoc of (string * t) list
| `List of t list
]
All possible cases defined in Yojson:
("abc", 123)
.<"Foo">
or <"Bar":123>
.type json = t
* Compatibility type alias for type `t`
val to_string : ?buf:Bi_outbuf.t -> ?len:int -> ?std:bool -> t -> string
Write a compact JSON value to a string.
val to_channel :
?buf:Bi_outbuf.t ->
?len:int ->
?std:bool ->
Stdlib.out_channel ->
t ->
unit
Write a compact JSON value to a channel.
val to_output :
?buf:Bi_outbuf.t ->
?len:int ->
?std:bool ->
< output : string -> int -> int -> int.. > ->
t ->
unit
Write a compact JSON value to an OO channel.
val to_file : ?len:int -> ?std:bool -> string -> t -> unit
Write a compact JSON value to a file. See to_string
for the role of the optional arguments.
val to_outbuf : ?std:bool -> Bi_outbuf.t -> t -> unit
Write a compact JSON value to an existing buffer. See to_string
for the role of the optional argument.
val stream_to_string :
?buf:Bi_outbuf.t ->
?len:int ->
?std:bool ->
t Stream.t ->
string
Write a newline-separated sequence of compact one-line JSON values to a string. See to_string
for the role of the optional arguments.
val stream_to_channel :
?buf:Bi_outbuf.t ->
?len:int ->
?std:bool ->
Stdlib.out_channel ->
t Stream.t ->
unit
Write a newline-separated sequence of compact one-line JSON values to a channel. See to_channel
for the role of the optional arguments.
Write a newline-separated sequence of compact one-line JSON values to a file. See to_string
for the role of the optional arguments.
val stream_to_outbuf : ?std:bool -> Bi_outbuf.t -> t Stream.t -> unit
Write a newline-separated sequence of compact one-line JSON values to an existing buffer. See to_string
for the role of the optional arguments.
val write_t : Bi_outbuf.t -> t -> unit
Write the given JSON value to the given buffer. Provided as a writer function for atdgen.
Sort object fields (stable sort, comparing field names and treating them as byte sequences)
val pp : Stdlib.Format.formatter -> t -> unit
Pretty printer, useful for debugging
val show : t -> string
Convert value to string, useful for debugging
equal a b
is the monomorphic equality. Determines whether two JSON values are considered equal. In the case of JSON objects, the order of the keys does not matter, except for duplicate keys which will be considered equal as long as they are in the same input order.
val pretty_format : ?std:bool -> t -> Easy_format.t
Convert into a pretty-printable tree. See to_string
for the role of the optional std
argument.
val pretty_print : ?std:bool -> Stdlib.Format.formatter -> t -> unit
Pretty-print into a Format.formatter
. See to_string
for the role of the optional std
argument.
val pretty_to_string : ?std:bool -> t -> string
Pretty-print into a string. See to_string
for the role of the optional std
argument.
val pretty_to_channel : ?std:bool -> Stdlib.out_channel -> t -> unit
Pretty-print to a channel. See to_string
for the role of the optional std
argument.
Combined parser and pretty-printer. See to_string
for the role of the optional std
argument.
Combined parser and printer. See to_string
for the role of the optional std
argument.
val from_string : ?buf:Bi_outbuf.t -> ?fname:string -> ?lnum:int -> string -> t
Read a JSON value from a string.
val from_channel :
?buf:Bi_outbuf.t ->
?fname:string ->
?lnum:int ->
Stdlib.in_channel ->
t
Read a JSON value from a channel. See from_string
for the meaning of the optional arguments.
val from_file : ?buf:Bi_outbuf.t -> ?fname:string -> ?lnum:int -> string -> t
Read a JSON value from a file. See from_string
for the meaning of the optional arguments.
type lexer_state = Lexer_state.t = {
buf : Bi_outbuf.t;
mutable lnum : int;
mutable bol : int;
mutable fname : string option;
}
This alias is provided for backward compatibility. New code should refer to Yojson.lexer_state
directly.
val init_lexer :
?buf:Bi_outbuf.t ->
?fname:string ->
?lnum:int ->
unit ->
lexer_state
This alias is provided for backward compatibility. New code should use Yojson.init_lexer
directly.
val from_lexbuf : lexer_state -> ?stream:bool -> Stdlib.Lexing.lexbuf -> t
Read a JSON value from a lexbuf. A valid initial lexer_state
can be created with init_lexer
. See from_string
for the meaning of the optional arguments.
val stream_from_string :
?buf:Bi_outbuf.t ->
?fname:string ->
?lnum:int ->
string ->
t Stream.t
Input a sequence of JSON values from a string. Whitespace between JSON values is fine but not required. See from_string
for the meaning of the optional arguments.
val stream_from_channel :
?buf:Bi_outbuf.t ->
?fin:(unit -> unit) ->
?fname:string ->
?lnum:int ->
Stdlib.in_channel ->
t Stream.t
Input a sequence of JSON values from a channel. Whitespace between JSON values is fine but not required.
val stream_from_file :
?buf:Bi_outbuf.t ->
?fname:string ->
?lnum:int ->
string ->
t Stream.t
Input a sequence of JSON values from a file. Whitespace between JSON values is fine but not required.
See from_string
for the meaning of the optional arguments.
val stream_from_lexbuf :
lexer_state ->
?fin:(unit -> unit) ->
Stdlib.Lexing.lexbuf ->
t Stream.t
Input a sequence of JSON values from a lexbuf. A valid initial lexer_state
can be created with init_lexer
. Whitespace between JSON values is fine but not required.
The type of values resulting from a parsing attempt of a JSON value.
val linestream_from_channel :
?buf:Bi_outbuf.t ->
?fin:(unit -> unit) ->
?fname:string ->
?lnum:int ->
Stdlib.in_channel ->
json_line Stream.t
Input a sequence of JSON values, one per line, from a channel. Exceptions raised when reading malformed lines are caught and represented using `Exn
.
See stream_from_channel
for the meaning of the optional fin
argument. See from_string
for the meaning of the other optional arguments.
val linestream_from_file :
?buf:Bi_outbuf.t ->
?fname:string ->
?lnum:int ->
string ->
json_line Stream.t
Input a sequence of JSON values, one per line, from a file. Exceptions raised when reading malformed lines are caught and represented using `Exn
.
See stream_from_channel
for the meaning of the optional fin
argument. See from_string
for the meaning of the other optional arguments.
val read_t : lexer_state -> Stdlib.Lexing.lexbuf -> t
Read a JSON value from the given lexer_state and lexing buffer and return it. Provided as a reader function for atdgen.