package tezos-lwt-result-stdlib

  1. Overview
  2. Docs
Tezos: error-aware stdlib replacement

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-v12.3.tar.bz2
sha256=296bb5674bc6050afe6330326fbdd0dfc2255d414bfd6b79cc7666ac6b39316d
sha512=c061cd300a9410300851158d77bf8e56ca3c568b0b1161b38305e5b2efdcd9c746d391f832fdb2826f9a1d6babce10a9b764a4b04f5df42699f7314b9863123a

doc/traced_structs/Traced_structs/Monad/Make/Lwt_traced_result_syntax/index.html

Module Make.Lwt_traced_result_syntaxSource

The Lwt traced Result monad: for concurrent successes and traced failures

The Lwt_traced_result_syntax module is similar to the Lwt_result_syntax module with the following difference:

  • fail wraps the error in a trace,
  • and* and and+ are provided.

See Lwt_result_syntax.

val return : 'a -> ('a, 'error) Stdlib.result Lwt.t
val return_unit : (unit, 'error) Stdlib.result Lwt.t
val return_none : ('a option, 'error) Stdlib.result Lwt.t
val return_some : 'a -> ('a option, 'error) Stdlib.result Lwt.t
val return_nil : ('a list, 'error) Stdlib.result Lwt.t
val return_true : (bool, 'error) Stdlib.result Lwt.t
val return_false : (bool, 'error) Stdlib.result Lwt.t
Sourceval fail : 'error -> ('a, 'error trace) Stdlib.result Lwt.t

fail e is Lwt.return (Error (Trace.make e)) where Trace is the Traced_sigs.Trace module that provides the trace type and functions.

val (let*) : ('a, 'e) Stdlib.result Lwt.t -> ('a -> ('b, 'e) Stdlib.result Lwt.t) -> ('b, 'e) Stdlib.result Lwt.t
Sourceval (and*) : ('a, 'e trace) Stdlib.result Lwt.t -> ('b, 'e trace) Stdlib.result Lwt.t -> ('a * 'b, 'e trace) Stdlib.result Lwt.t
val (let+) : ('a, 'e) Stdlib.result Lwt.t -> ('a -> 'b) -> ('b, 'e) Stdlib.result Lwt.t
Sourceval (and+) : ('a, 'e trace) Stdlib.result Lwt.t -> ('b, 'e trace) Stdlib.result Lwt.t -> ('a * 'b, 'e trace) Stdlib.result Lwt.t
val (let*!) : 'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t
val (let*?) : ('a, 'e) Stdlib.result -> ('a -> ('b, 'e) Stdlib.result Lwt.t) -> ('b, 'e) Stdlib.result Lwt.t
Sourceval join : (unit, 'error trace) Stdlib.result Lwt.t list -> (unit, 'error trace) Stdlib.result Lwt.t
Sourceval all : ('a, 'error trace) Stdlib.result Lwt.t list -> ('a list, 'error trace) Stdlib.result Lwt.t
Sourceval both : ('a, 'error trace) Stdlib.result Lwt.t -> ('b, 'error trace) Stdlib.result Lwt.t -> ('a * 'b, 'error trace) Stdlib.result Lwt.t
OCaml

Innovation. Community. Security.