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 Lwt_result_syntax with additional utilities for wrapping results produced by the protocol, i.e. Environment.Error_monad.tzresult, to tzresult Lwt.t values used in the tests.

The added utilities are binding operators. They use the same symbols as the ones from Lwt_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.Lwt_result_syntax

include module type of Tezos_error_monad.TzLwtreslib.Monad.Lwt_result_syntax

val return : 'a -> ('a, 'e) result Lwt.t

val return_unit : (unit, 'e) result Lwt.t

val return_none : ('a option, 'e) result Lwt.t

val return_some : 'a -> ('a option, 'e) result Lwt.t

val return_nil : ('a list, 'e) result Lwt.t

val return_true : (bool, 'e) result Lwt.t

val return_false : (bool, 'e) result Lwt.t

val fail : 'e -> ('a, 'e) result Lwt.t

val let* : 
  ('a, 'e) result Lwt.t ->
  ('a -> ('b, 'e) result Lwt.t) ->
  ('b, 'e) result Lwt.t

val let+ : ('a, 'e) result Lwt.t -> ('a -> 'b) -> ('b, 'e) result Lwt.t

val lwt_map_error : 
  ('e -> 'f) ->
  ('a, 'e) result Lwt.t ->
  ('a, 'f) result Lwt.t

val let*! : 'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t

val let*? : 
  ('a, 'e) result ->
  ('a -> ('b, 'e) result Lwt.t) ->
  ('b, 'e) result Lwt.t

val join : (unit, 'e) result Lwt.t list -> (unit, 'e list) result Lwt.t

val all : ('a, 'e) result Lwt.t list -> ('a list, 'e list) result Lwt.t

val both : 
  ('a, 'e) result Lwt.t ->
  ('b, 'e) result Lwt.t ->
  ('a * 'b, 'e list) result Lwt.t

val tzfail : 
  'error ->
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t

val and* : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t ->
  ('b, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t ->
  ('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t

val and+ : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t ->
  ('b, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t ->
  ('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t

val tzjoin : 
  (unit, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t list ->
  (unit, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t

val tzall : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t list ->
  ('a list, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t

val tzboth : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t ->
  ('b, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t ->
  ('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) result Lwt.t

val wrap : 
  'a Tezos_protocol_020_PsParisC.Environment.Error_monad.tzresult Lwt.t ->
  'a Tezos_base.TzPervasives.tzresult Lwt.t

wrap res maps the result type contained in res to a tzresult value.

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 Lwt.t ->
  ('a -> 'b Tezos_base.TzPervasives.tzresult Lwt.t) ->
  'b Tezos_base.TzPervasives.tzresult Lwt.t

let*@ x = m in f x is equivalent to let* x = wrap 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 Tezos_base.TzPervasives.tzresult Lwt.t) ->
  'b Tezos_base.TzPervasives.tzresult Lwt.t

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 Lwt.t ->
  ('a Tezos_base.TzPervasives.tzresult -> 'b Lwt.t) ->
  'b Lwt.t

let*!@ x = m in f x is equivalent to let*! x = wrap m in f x.

Mnemonic: @ "wraps" a protocol error in a shell error.

val let+@ : 
  'a Tezos_protocol_020_PsParisC.Environment.Error_monad.tzresult Lwt.t ->
  ('a -> 'b) ->
  'b Tezos_base.TzPervasives.tzresult Lwt.t

let+@ x = m in f x is equivalent to let+ x = wrap m in f x.

Mnemonic: @ "wraps" a protocol error in a shell error.