package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

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

doc/octez-libs.lwt-result-stdlib/Tezos_lwt_result_stdlib/Lwtreslib/Traced/Monad/Result_syntax/index.html

Module Monad.Result_syntax

Syntax module for Result. This is intended to be opened locally in functions which use result for control-flow. Within the scope of this module, the code can include binding operators, leading to a let-style syntax.

See also Result

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

return x is Ok x.

val return_unit : (unit, 'e) result

return_unit is Ok ().

val return_none : ('a option, 'e) result

return_none is Ok None.

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

return_some x is Ok (Some x).

val return_nil : ('a list, 'e) result

return_nil is Ok [].

val return_true : (bool, 'e) result

return_true is Ok true.

val return_false : (bool, 'e) result

return_false is Ok false.

Note that we do not provide return_ok nor return_error. Both of these functions are possible but somewhat confusing and rarely useful in practice. If you need to carry results within a Result-monad computation (yielding to values of the type (('a, 'e) result, 'e) result), you need to do so by hand: return (Ok …) and return (Error …).

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

fail e is Error e. It is also an alias for error.

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

let* is a binding operator alias for Result.bind and >>?.

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

let+ is a binding operator alias for Result.map and >|?.

Note that we do not provide and* nor and+. Both of these are possible but their type is unsatisfying because the errors do not compose well. You can use both (below) if need be.

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

join is the joining of success/failure unit values.

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

all is the joining of success/failure non-unit values.

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

both is the joining of two success/failure non-unit values.