package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file monad.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2020 Nomadic Labs <contact@nomadic-labs.com>                *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

(** [S] is the signature for a Lwt, result and Lwt-result combined monad. It is
    similar to {!Bare_sigs.Monad} with the addition of traces. Specifically:

    - The type ['error trace] is meant to be substituted by a type provided by a
      [Trace] module ([with type 'error trace := 'error Trace.trace]).
    - The functions {!Traced_result_syntax.fail} and
      {!Traced_lwt_result_syntax.fail} wrap the provided error in a trace,
    - [{join,all,both}] return ['error trace] rather than ['error list],
    - The binding operators {!Traced_result_syntax.( and* )} and
      {!Traced_lwt_result_syntax.( and* )} are available.
    *)
module type S = sig
  (** Import the non-traced modules as-is *)
  include Bare_sigs.Monad.S

  (** ['error trace] is intended to be substituted by a type provided by a
      [Trace] module ([with type 'error trace := 'error Trace.trace]) *)
  type 'error trace

  (** {2 The traced Result monad: for successes and traced failures}

      The [Traced_result_syntax] module is similar to the [Result_syntax] module
      with the following differences:
      - [fail] wraps the error in a trace,
      - [and*] and [and+] are provided

      See {!Result_syntax}. *)
  module Traced_result_syntax : sig
    val return : 'a -> ('a, 'error) result

    val return_unit : (unit, 'error) result

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

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

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

    val return_true : (bool, 'error) result

    val return_false : (bool, 'error) result

    (** [fail e] is [(Error (Trace.make e))] where [Trace] is the
      {!Traced_sigs.Trace} module that provides the trace type and functions. *)
    val fail : 'error -> ('a, 'error trace) result

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

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

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

    val ( and+ ) :
      ('a, 'e trace) result ->
      ('b, 'e trace) result ->
      ('a * 'b, 'e trace) result

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

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

    val both :
      ('a, 'error trace) result ->
      ('b, 'error trace) result ->
      ('a * 'b, 'error trace) result
  end

  (** {2 The Lwt traced Result monad: for concurrent successes and traced failures}

      The [Lwt_traced_result_syntax] module is similar to the
      [Lwt_result_syntax] module with the following difference:
      - [fail] wraps the error in a trace,
      - [and*] and [and+] are provided.

      See {!Lwt_result_syntax}. *)
  module Lwt_traced_result_syntax : sig
    val return : 'a -> ('a, 'error) result Lwt.t

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

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

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

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

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

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

    (** [fail e] is [Lwt.return (Error (Trace.make e))] where [Trace] is the
      {!Traced_sigs.Trace} module that provides the trace type and functions. *)
    val fail : 'error -> ('a, 'error trace) result Lwt.t

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

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

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

    val ( and+ ) :
      ('a, 'e trace) result Lwt.t ->
      ('b, 'e trace) result Lwt.t ->
      ('a * 'b, 'e trace) 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, 'error trace) result Lwt.t list ->
      (unit, 'error trace) result Lwt.t

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

    val both :
      ('a, 'error trace) result Lwt.t ->
      ('b, 'error trace) result Lwt.t ->
      ('a * 'b, 'error trace) result Lwt.t
  end
end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct