package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Traced is a functor to generate advanced combined-monad replacements for parts of the Stdlib. The generated module is similar to Bare with the addition of traces: structured collections of errors.

For convenience, the monad includes primitives to error directly with a trace rather than a bare error.

All the _ep traversors return traces of errors rather than lists of errors. The _ep traversors preserve their best-effort semantic.

Additional functions in the Monad allow the construction of sequential traces: functions to enrich traces with new errors. E.g.,

let load_config file =
   Result.map_error
     (fun trace ->
        Trace.cons "cannot load configuration file" trace)
   @@ begin
     let open Lwt_result_syntax in
     let* file = open_file in
     let* lines = read_lines file in
     let* json = parse_config lines in
     make_dictionary json
   end

Example implementations of traces are provided in the traces/ directory.

Parameters

module Trace : TRACE

Signature

module Monad : TRACED_MONAD with type 'error trace = 'error Trace.trace
module Hashtbl : Traced_sigs.Hashtbl.S with type 'error trace := 'error Trace.trace
module List : Traced_sigs.List.S with type 'error trace := 'error Trace.trace
module Map : Traced_sigs.Map.S with type 'error trace := 'error Trace.trace
module Seq : Traced_sigs.Seq.S with type 'error trace := 'error Trace.trace
module Seq_s : Traced_sigs.Seq_s.S with type 'error trace := 'error Trace.trace
module Seq_es : Traced_sigs.Seq_es.S with type ('a, 'e) seq_e_t := ('a, 'e) Seq_e.t and type 'a seq_s_t := 'a Seq_s.t
module Set : Traced_sigs.Set.S with type 'error trace := 'error Trace.trace
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct