include Sig.CORE with type error := unwrappedval error_encoding : unwrapped Data_encoding.tval pp : Format.formatter -> unwrapped -> unitinclude Sig.EXT with type error := unwrappedval register_error_kind :
Sig.error_category ->
id:string ->
title:string ->
description:string ->
?pp:(Format.formatter -> 'err -> unit) ->
'err Data_encoding.t ->
(unwrapped -> 'err option) ->
('err -> unwrapped) ->
unitThe error data type is extensible. Each module can register specialized error serializers id unique name of this error. Ex.: overflow_time_counter title more readable name. Ex.: Overflow of time counter description human readable description. Ex.: The time counter overflowed while computing delta increase pp formatter used to pretty print additional arguments. Ex.: The time counter overflowed while computing delta increase. Previous value %d. Delta: %d encoder decoder data encoding for this error. If the error has no value, specify Data_encoding.empty
val register_recursive_error_kind :
Sig.error_category ->
id:string ->
title:string ->
description:string ->
pp:(Format.formatter -> 'err -> unit) ->
(unwrapped Data_encoding.t -> 'err Data_encoding.t) ->
(unwrapped -> 'err option) ->
('err -> unwrapped) ->
unitSame as register_error_kind but allow errors to wrap other errors.
The encoding argument is a function which will be given the encoding of errors as argument so that you can encode errors in errors using a fixpoint.
Another difference with register_error_kind is that pp is mandatory.
val classify_error : unwrapped -> Sig.error_categoryClassify an error using the registered kinds
type unwrapped += private Catch all error when 'serializing' an error.
val json_of_error : unwrapped -> Data_encoding.jsonAn error serializer
val error_of_json : Data_encoding.json -> unwrappedtype error_info = {category : Sig.error_category;id : string;title : string;description : string;schema : Data_encoding.json_schema;}Error information
val pp_info : Format.formatter -> error_info -> unitval get_registered_errors : unit -> error_info listRetrieves information of registered errors