TzTrace (p.tezos-error-monad.17.3.doc.tezos-error-monad.Tezos_error

A trace is a stack of errors. It is implemented as an error list but such a list MUST NEVER be empty.

It is implemented as a concrete error list for backwards compatibility but future improvements might modify the type or render the type abstract.

include Sig.TRACE with type 'err trace = 'err list

The trace type (included as part of the Tezos_lwt_result_stdlib.Lwtreslib.TRACE module is abstract in this interface but it is made concrete in the instantiated error monad (see error_monad.mli).

The idea of abstracting the trace is so that it can evolve more easily. Eventually, we can make the trace abstract in the instantiated error monad, we can have different notions of traces for the protocol and the shell, etc.

include Tezos_lwt_result_stdlib.Lwtreslib.TRACE
  with type 'err trace = 'err list

Sourcetype 'err trace = 'err list

Sourceval make : 'error -> 'error trace

Sourceval cons : 'error -> 'error trace -> 'error trace

Sourceval cons_list : 'error -> 'error list -> 'error trace

Sourceval conp : 'error trace -> 'error trace -> 'error trace

Sourceval conp_list : 'err trace -> 'err trace list -> 'err trace

Source

val pp_print : 
  (Format.formatter -> 'err -> unit) ->
  Format.formatter ->
  'err trace ->
  unit

pp_print pretty-prints a trace of errors

Source

val pp_print_top : 
  (Format.formatter -> 'err -> unit) ->
  Format.formatter ->
  'err trace ->
  unit

pp_print_top pretty-prints the top errors of the trace

Sourceval encoding : 'error Data_encoding.t -> 'error trace Data_encoding.t

Sourceval fold : ('a -> 'error -> 'a) -> 'a -> 'error trace -> 'a

fold f init trace traverses the trace (in an unspecified manner) so that init is folded over each of the error within trace by f. Typical use is to find the worst error, to check for the presence of a given error, etc.