package jsont

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

Encoding, decoding and query errors.

Kinds of errors

type kind

The type for kind of errors.

val kind_to_string : kind -> string

kind_to_string kind is kind as a string.

module Context : sig ... end

JSON error contexts.

type t = Context.t * Meta.t * kind

The type for errors. The context, the error localisation and the kind of error.

val raise : Context.t -> Meta.t -> kind -> 'a

raise ctx meta k raises an error with given paramters.

val make_msg : Context.t -> Meta.t -> string -> t

make_msg ctx meta msg is an error with message msg for meta meta in context ctx.

val msg : Meta.t -> string -> 'a

msg meta msg raises an error with message msg for meta meta in an empty context.

val msgf : 
  Meta.t ->
  ('a, Stdlib.Format.formatter, unit, 'b) Stdlib.format4 ->
  'a

msgf meta fmt … is like msg but formats an error message.

val push_array : string node -> int node -> t -> 'a

push_array kinded_sort n e contextualises e as an error in the nth element of an array of kinded sort kinded_sort.

val push_object : string node -> string node -> t -> 'a

push_object kinded_sort n e contextualises e as an error in the member n of an object of kinded sort kinded_sort.

val adjust_context : 
  first_byte:Textloc.byte_pos ->
  first_line:Textloc.line_pos ->
  t ->
  'a

adjust_context ~first_byte ~first_line adjusts the error's context's meta to encompass the given positions.

val to_string : t -> string

error_to_string e formats e using pp to a string.

val pp : t fmt

pp_error formats errors.

val puterr : unit fmt

puterr formats Error: in red.