package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Octez protocol alpha libraries

Install

Dune Dependency

Authors

Maintainers

Sources

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/Result_wrap_syntax/index.html

Module Tezos_alpha_test_helpers.Result_wrap_syntaxSource

Extends the Result_syntax with additional utilities for wrapping results produced by the protocol, i.e. Environment.Error_monad.tzresult, to tzresult values used in the tests.

The added utilities are binding operators. They use the same symbols as the ones from Result_syntax with an added @ character. This character symbolizes the ewrapping of the internal error monad type in a shell error.

include module type of Tezos_base.TzPervasives.Result_syntax
include module type of Tezos_error_monad.TzLwtreslib.Monad.Result_syntax
val return : 'a -> ('a, 'e) result
val return_unit : (unit, 'e) result
val return_none : ('a option, 'e) result
val return_some : 'a -> ('a option, 'e) result
val return_nil : ('a list, 'e) result
val return_true : (bool, 'e) result
val return_false : (bool, 'e) result
val fail : 'e -> ('a, 'e) result
val (let*) : ('a, 'e) result -> ('a -> ('b, 'e) result) -> ('b, 'e) result
val (let+) : ('a, 'e) result -> ('a -> 'b) -> ('b, 'e) result
val join : (unit, 'e) result list -> (unit, 'e list) result
val all : ('a, 'e) result list -> ('a list, 'e list) result
val both : ('a, 'e) result -> ('b, 'e) result -> ('a * 'b, 'e list) result
val tzfail : 'error -> ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result
Sourceval wrap : 'a Tezos_protocol_alpha.Environment.Error_monad.tzresult -> 'a Tezos_base.TzPervasives.tzresult

wrap res is equivalent to Environment.wrap_tzresult res

Sourceval (let@) : 'a Tezos_protocol_alpha.Environment.Error_monad.tzresult -> ('a Tezos_base.TzPervasives.tzresult -> 'b) -> 'b

let@ x = m in f x is equivalent to let x = Environment.wrap_tzresult m in f x

Sourceval (let*@) : 'a Tezos_protocol_alpha.Environment.Error_monad.tzresult -> ('a -> 'b Tezos_base.TzPervasives.tzresult) -> 'b Tezos_base.TzPervasives.tzresult

let*@ x = m in f x is equivalent to let* x = Environment.wrap_tzresult m in f x. Mnemonic: @ "wraps" a protocol error in a shell error.

Sourceval (let+@) : 'a Tezos_protocol_alpha.Environment.Error_monad.tzresult -> ('a -> 'b) -> 'b Tezos_base.TzPervasives.tzresult

let+@ x = m in f x is equivalent to let+ x = Environment.wrap_tzresult m in f x. Mnemonic: @ "wraps" a protocol error in a shell error.

OCaml

Innovation. Community. Security.