Sexplib.Conv
Utility Module for S-expression Conversions
include module type of Sexplib0.Sexp_conv
val default_string_of_float : (float -> string) ref
default_string_of_float
reference to the default function used to convert floats to strings.
Initially set to fun n -> sprintf "%.20G" n
.
val write_old_option_format : bool ref
write_old_option_format
reference for the default option format used to write option values. If set to true
, the old-style option format will be used, the new-style one otherwise.
Initially set to true
.
val read_old_option_format : bool ref
read_old_option_format
reference for the default option format used to read option values. Of_sexp_error
will be raised with old-style option values if this reference is set to false
. Reading new-style option values is always supported. Using a global reference instead of changing the converter calling conventions is the only way to avoid breaking old code with the standard macros.
Initially set to true
.
We re-export a tail recursive map function, because some modules override the standard library functions (e.g. StdLabels
) which wrecks havoc with the camlp4 extension.
val sexp_of_unit : unit -> Sexplib0.Sexp.t
sexp_of_unit ()
converts a value of type unit
to an S-expression.
val sexp_of_bool : bool -> Sexplib0.Sexp.t
sexp_of_bool b
converts the value x
of type bool
to an S-expression.
val sexp_of_string : string -> Sexplib0.Sexp.t
sexp_of_bool str
converts the value str
of type string
to an S-expression.
val sexp_of_bytes : bytes -> Sexplib0.Sexp.t
sexp_of_bool str
converts the value str
of type bytes
to an S-expression.
val sexp_of_char : char -> Sexplib0.Sexp.t
sexp_of_char c
converts the value c
of type char
to an S-expression.
val sexp_of_int : int -> Sexplib0.Sexp.t
sexp_of_int n
converts the value n
of type int
to an S-expression.
val sexp_of_float : float -> Sexplib0.Sexp.t
sexp_of_float n
converts the value n
of type float
to an S-expression.
val sexp_of_int32 : int32 -> Sexplib0.Sexp.t
sexp_of_int32 n
converts the value n
of type int32
to an S-expression.
val sexp_of_int64 : int64 -> Sexplib0.Sexp.t
sexp_of_int64 n
converts the value n
of type int64
to an S-expression.
val sexp_of_nativeint : nativeint -> Sexplib0.Sexp.t
sexp_of_nativeint n
converts the value n
of type nativeint
to an S-expression.
val sexp_of_ref : ('a -> Sexplib0.Sexp.t) -> 'a ref -> Sexplib0.Sexp.t
sexp_of_ref conv r
converts the value r
of type 'a ref
to an S-expression. Uses conv
to convert values of type 'a
to an S-expression.
val sexp_of_lazy_t : ('a -> Sexplib0.Sexp.t) -> 'a lazy_t -> Sexplib0.Sexp.t
sexp_of_lazy_t conv l
converts the value l
of type 'a lazy_t
to an S-expression. Uses conv
to convert values of type 'a
to an S-expression.
val sexp_of_option : ('a -> Sexplib0.Sexp.t) -> 'a option -> Sexplib0.Sexp.t
sexp_of_option conv opt
converts the value opt
of type 'a
option
to an S-expression. Uses conv
to convert values of type 'a
to an S-expression.
val sexp_of_pair :
('a -> Sexplib0.Sexp.t) ->
('b -> Sexplib0.Sexp.t) ->
('a * 'b) ->
Sexplib0.Sexp.t
sexp_of_pair conv1 conv2 pair
converts a pair to an S-expression. It uses its first argument to convert the first element of the pair, and its second argument to convert the second element of the pair.
val sexp_of_triple :
('a -> Sexplib0.Sexp.t) ->
('b -> Sexplib0.Sexp.t) ->
('c -> Sexplib0.Sexp.t) ->
('a * 'b * 'c) ->
Sexplib0.Sexp.t
sexp_of_triple conv1 conv2 conv3 triple
converts a triple to an S-expression using conv1
, conv2
, and conv3
to convert its elements.
val sexp_of_list : ('a -> Sexplib0.Sexp.t) -> 'a list -> Sexplib0.Sexp.t
sexp_of_list conv lst
converts the value lst
of type 'a
list
to an S-expression. Uses conv
to convert values of type 'a
to an S-expression.
val sexp_of_array : ('a -> Sexplib0.Sexp.t) -> 'a array -> Sexplib0.Sexp.t
sexp_of_array conv ar
converts the value ar
of type 'a
array
to an S-expression. Uses conv
to convert values of type 'a
to an S-expression.
val sexp_of_hashtbl :
('a -> Sexplib0.Sexp.t) ->
('b -> Sexplib0.Sexp.t) ->
('a, 'b) Hashtbl.t ->
Sexplib0.Sexp.t
sexp_of_hashtbl conv_key conv_value htbl
converts the value htbl
of type ('a, 'b) Hashtbl.t
to an S-expression. Uses conv_key
to convert the hashtable keys of type 'a
, and conv_value
to convert hashtable values of type 'b
to S-expressions.
val sexp_of_opaque : 'a -> Sexplib0.Sexp.t
sexp_of_opaque x
converts the value x
of opaque type to an S-expression. This means the user need not provide converters, but the result cannot be interpreted.
val sexp_of_fun : ('a -> 'b) -> Sexplib0.Sexp.t
sexp_of_fun f
converts the value f
of function type to a dummy S-expression. Functions cannot be serialized as S-expressions, but at least a placeholder can be generated for pretty-printing.
exception Of_sexp_error of exn * Sexplib0.Sexp.t
Of_sexp_error (exn, sexp)
the exception raised when an S-expression could not be successfully converted to an OCaml-value.
val record_check_extra_fields : bool ref
record_check_extra_fields
checks for extra (= unknown) fields in record S-expressions.
val of_sexp_error : string -> Sexplib0.Sexp.t -> 'a
of_sexp_error reason sexp
val of_sexp_error_exn : exn -> Sexplib0.Sexp.t -> 'a
of_sexp_error exc sexp
val unit_of_sexp : Sexplib0.Sexp.t -> unit
unit_of_sexp sexp
converts S-expression sexp
to a value of type unit
.
val bool_of_sexp : Sexplib0.Sexp.t -> bool
bool_of_sexp sexp
converts S-expression sexp
to a value of type bool
.
val string_of_sexp : Sexplib0.Sexp.t -> string
string_of_sexp sexp
converts S-expression sexp
to a value of type string
.
val bytes_of_sexp : Sexplib0.Sexp.t -> bytes
bytes_of_sexp sexp
converts S-expression sexp
to a value of type bytes
.
val char_of_sexp : Sexplib0.Sexp.t -> char
char_of_sexp sexp
converts S-expression sexp
to a value of type char
.
val int_of_sexp : Sexplib0.Sexp.t -> int
int_of_sexp sexp
converts S-expression sexp
to a value of type int
.
val float_of_sexp : Sexplib0.Sexp.t -> float
float_of_sexp sexp
converts S-expression sexp
to a value of type float
.
val int32_of_sexp : Sexplib0.Sexp.t -> int32
int32_of_sexp sexp
converts S-expression sexp
to a value of type int32
.
val int64_of_sexp : Sexplib0.Sexp.t -> int64
int64_of_sexp sexp
converts S-expression sexp
to a value of type int64
.
val nativeint_of_sexp : Sexplib0.Sexp.t -> nativeint
nativeint_of_sexp sexp
converts S-expression sexp
to a value of type nativeint
.
val ref_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a ref
ref_of_sexp conv sexp
converts S-expression sexp
to a value of type 'a ref
using conversion function conv
, which converts an S-expression to a value of type 'a
.
val lazy_t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a lazy_t
lazy_t_of_sexp conv sexp
converts S-expression sexp
to a value of type 'a lazy_t
using conversion function conv
, which converts an S-expression to a value of type 'a
.
val option_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a option
option_of_sexp conv sexp
converts S-expression sexp
to a value of type 'a option
using conversion function conv
, which converts an S-expression to a value of type 'a
.
val pair_of_sexp :
(Sexplib0.Sexp.t -> 'a) ->
(Sexplib0.Sexp.t -> 'b) ->
Sexplib0.Sexp.t ->
'a * 'b
pair_of_sexp conv1 conv2 sexp
converts S-expression sexp
to a pair of type 'a * 'b
using conversion functions conv1
and conv2
, which convert S-expressions to values of type 'a
and 'b
respectively.
val triple_of_sexp :
(Sexplib0.Sexp.t -> 'a) ->
(Sexplib0.Sexp.t -> 'b) ->
(Sexplib0.Sexp.t -> 'c) ->
Sexplib0.Sexp.t ->
'a * 'b * 'c
triple_of_sexp conv1 conv2 conv3 sexp
converts S-expression sexp
to a triple of type 'a * 'b * 'c
using conversion functions conv1
, conv2
, and conv3
, which convert S-expressions to values of type 'a
, 'b
, and 'c
respectively.
val list_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a list
list_of_sexp conv sexp
converts S-expression sexp
to a value of type 'a list
using conversion function conv
, which converts an S-expression to a value of type 'a
.
val array_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a array
array_of_sexp conv sexp
converts S-expression sexp
to a value of type 'a array
using conversion function conv
, which converts an S-expression to a value of type 'a
.
val hashtbl_of_sexp :
(Sexplib0.Sexp.t -> 'a) ->
(Sexplib0.Sexp.t -> 'b) ->
Sexplib0.Sexp.t ->
('a, 'b) Hashtbl.t
hashtbl_of_sexp conv_key conv_value sexp
converts S-expression sexp
to a value of type ('a, 'b) Hashtbl.t
using conversion function conv_key
, which converts an S-expression to hashtable key of type 'a
, and function conv_value
, which converts an S-expression to hashtable value of type 'b
.
val opaque_of_sexp : Sexplib0.Sexp.t -> 'a
opaque_of_sexp sexp
val fun_of_sexp : Sexplib0.Sexp.t -> 'a
fun_of_sexp sexp
Sexp Grammars
val sexp_grammar_with_tags :
Sexplib0.Sexp_grammar.grammar ->
tags:(string * Sexplib0.Sexp.t) list ->
Sexplib0.Sexp_grammar.grammar
val sexp_grammar_with_tag_list :
'a Sexplib0.Sexp_grammar.with_tag_list ->
tags:(string * Sexplib0.Sexp.t) list ->
'a Sexplib0.Sexp_grammar.with_tag_list
Sexp grammar definitions.
val unit_sexp_grammar : unit Sexplib0.Sexp_grammar.t
val bool_sexp_grammar : bool Sexplib0.Sexp_grammar.t
val string_sexp_grammar : string Sexplib0.Sexp_grammar.t
val bytes_sexp_grammar : bytes Sexplib0.Sexp_grammar.t
val char_sexp_grammar : char Sexplib0.Sexp_grammar.t
val int_sexp_grammar : int Sexplib0.Sexp_grammar.t
val float_sexp_grammar : float Sexplib0.Sexp_grammar.t
val int32_sexp_grammar : int32 Sexplib0.Sexp_grammar.t
val int64_sexp_grammar : int64 Sexplib0.Sexp_grammar.t
val nativeint_sexp_grammar : nativeint Sexplib0.Sexp_grammar.t
val sexp_t_sexp_grammar : Sexplib0.Sexp.t Sexplib0.Sexp_grammar.t
val ref_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a ref Sexplib0.Sexp_grammar.t
val lazy_t_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a lazy_t Sexplib0.Sexp_grammar.t
val option_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a option Sexplib0.Sexp_grammar.t
val list_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a list Sexplib0.Sexp_grammar.t
val array_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a array Sexplib0.Sexp_grammar.t
val opaque_sexp_grammar : 'a Sexplib0.Sexp_grammar.t
val fun_sexp_grammar : 'a Sexplib0.Sexp_grammar.t
Exception converters
val sexp_of_exn : exn -> Sexplib0.Sexp.t
sexp_of_exn exc
converts exception exc
to an S-expression. If no suitable converter is found, the standard converter in Printexc
will be used to generate an atomic S-expression.
Converts an exception to a string via sexp, falling back to Printexc.to_string
if no sexp conversion is registered for this exception.
This is different from Printexc.to_string
in that it additionally uses the sexp converters registered with ~printexc:false
. Another difference is that the behavior of Printexc
can be overridden with Printexc.register
, but here we always try sexp conversion first.
val sexp_of_exn_opt : exn -> Sexplib0.Sexp.t option
sexp_of_exn_opt exc
converts exception exc
to Some sexp
. If no suitable converter is found, None
is returned instead.
module Exn_converter = Sexplib0.Sexp_conv.Exn_converter
type bigstring =
(char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t
type float32_vec =
(float, Bigarray.float32_elt, Bigarray.fortran_layout) Bigarray.Array1.t
type float64_vec =
(float, Bigarray.float64_elt, Bigarray.fortran_layout) Bigarray.Array1.t
type vec = float64_vec
type float32_mat =
(float, Bigarray.float32_elt, Bigarray.fortran_layout) Bigarray.Array2.t
type float64_mat =
(float, Bigarray.float64_elt, Bigarray.fortran_layout) Bigarray.Array2.t
type mat = float64_mat
sexp_of_bigstring bstr
converts a bigstring (character bigarray in C-layout) to an S-expression.
val sexp_of_float32_vec : float32_vec -> Sexp.t
sexp_of_float32_vec vec
converts the one-dimensional bigarray vec
of 32-bit floats in Fortran-layout to an S-expression.
val sexp_of_float64_vec : float64_vec -> Sexp.t
sexp_of_float64_vec vec
converts the one-dimensional bigarray vec
of 64-bit floats in Fortran-layout to an S-expression.
sexp_of_vec vec
same as Conv.sexp_of_float64_vec
.
val sexp_of_float32_mat : float32_mat -> Sexp.t
sexp_of_float32_mat mat
converts the two-dimensional bigarray mat
of 32-bit floats in Fortran-layout to an S-expression.
val sexp_of_float64_mat : float64_mat -> Sexp.t
sexp_of_float64_mat mat
converts the two-dimensional bigarray mat
of 64-bit floats in Fortran-layout to an S-expression.
sexp_of_mat mat
same as Conv.sexp_of_float64_mat
.
val string_of__of__sexp_of : ('a -> Sexp.t) -> 'a -> string
string_of__of__sexp_of conv x
converts the OCaml-value x
to an S-expression represented as a string by using conversion function conv
.
val bigstring_sexp_grammar : bigstring Sexplib0.Sexp_grammar.t
bigstring_of_sexp sexp
converts S-expression sexp
to a bigstring (character bigarray in C-layout).
val float32_vec_sexp_grammar : float32_vec Sexplib0.Sexp_grammar.t
val float32_vec_of_sexp : Sexp.t -> float32_vec
float32_vec_of_sexp sexp
converts S-expression sexp
to a one-dimensional bigarray of 32-bit floats in Fortran-layout.
val float64_vec_sexp_grammar : float64_vec Sexplib0.Sexp_grammar.t
val float64_vec_of_sexp : Sexp.t -> float64_vec
float64_vec_of_sexp sexp
converts S-expression sexp
to a one-dimensional bigarray of 64-bit floats in Fortran-layout.
val vec_sexp_grammar : vec Sexplib0.Sexp_grammar.t
vec_of_sexp sexp
same as float64_vec_of_sexp
.
val float32_mat_sexp_grammar : float32_mat Sexplib0.Sexp_grammar.t
val float32_mat_of_sexp : Sexp.t -> float32_mat
float32_mat_of_sexp sexp
converts S-expression sexp
to a two-dimensional bigarray of 32-bit floats in Fortran-layout.
val float64_mat_sexp_grammar : float64_mat Sexplib0.Sexp_grammar.t
val float64_mat_of_sexp : Sexp.t -> float64_mat
float64_mat_of_sexp sexp
converts S-expression sexp
to a two-dimensional bigarray of 64-bit floats in Fortran-layout.
val mat_sexp_grammar : mat Sexplib0.Sexp_grammar.t
mat_of_sexp sexp
same as Conv.float64_mat_of_sexp
.
val of_string__of__of_sexp : (Sexp.t -> 'a) -> string -> 'a
of_string__of__of_sexp conv str
converts the S-expression str
represented as a string to an OCaml-value by using conversion function conv
.