package octez-protocol-020-PsParisC-libs

You can search for identifiers within the package.

in-package search v0.2.0

Package contains no libraries

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

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

wrap res is equivalent to Environment.wrap_tzresult res

val let@ : 
  'a Tezos_protocol_020_PsParisC.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_020_PsParisC.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_020_PsParisC.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.