package octez-protocol-019-PtParisB-libs

  1. Overview
  2. Docs
Octez protocol 019-PtParisB libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (1)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-protocol-019-PtParisB-libs.test-helpers/Tezos_019_PtParisB_test_helpers/Result_wrap_syntax/index.html

Module Tezos_019_PtParisB_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_019_PtParisB.Environment.Error_monad.tzresult -> 'a Tezos_base.TzPervasives.tzresult

wrap res is equivalent to Environment.wrap_tzresult res

Sourceval (let@) : 'a Tezos_protocol_019_PtParisB.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_019_PtParisB.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_019_PtParisB.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.