package octez-protocol-alpha-libs
Install
Dune Dependency
Authors
Maintainers
Sources
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_syntax
Source
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 tzfail :
'error ->
('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result
val (and*) :
('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result ->
('b, 'error Tezos_base.TzPervasives.TzTrace.trace) result ->
('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) result
val (and+) :
('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result ->
('b, 'error Tezos_base.TzPervasives.TzTrace.trace) result ->
('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) result
val tzjoin :
(unit, 'error Tezos_base.TzPervasives.TzTrace.trace) result list ->
(unit, 'error Tezos_base.TzPervasives.TzTrace.trace) result
val tzall :
('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result list ->
('a list, 'error Tezos_base.TzPervasives.TzTrace.trace) result
val tzboth :
('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result ->
('b, 'error Tezos_base.TzPervasives.TzTrace.trace) result ->
('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) result
val wrap :
'a Tezos_protocol_alpha.Environment.Error_monad.tzresult ->
'a Tezos_base.TzPervasives.tzresult
wrap res
is equivalent to Environment.wrap_tzresult res
val (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
val (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.
val (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.