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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2021 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

module Lwt_syntax = struct
  include Lwt
  include Lwt.Syntax

  let return_ok_unit = Lwt.return (Ok ())

  let return_ok_true = Lwt.return (Ok true)

  let return_ok_false = Lwt.return (Ok false)

  let return_ok_none = Lwt.return (Ok None)

  let return_ok_nil = Lwt.return (Ok [])
end

module Option_syntax = struct
  let (return [@ocaml.inline "always"]) = fun x -> Some x

  let (fail [@ocaml.inline "always"]) = None

  let return_unit = return ()

  let return_nil = return []

  let return_true = return true

  let return_false = return false

  let ( let* ) = Stdlib.Option.bind

  let ( let+ ) o f = Stdlib.Option.map f o

  let both a b = match (a, b) with Some x, Some y -> Some (x, y) | _ -> None

  let ( and* ) = both

  let ( and+ ) = both
end

module Result_syntax = struct
  let (return [@ocaml.inline "always"]) = fun x -> Ok x

  let (fail [@ocaml.inline "always"]) = fun x -> Error x

  let return_unit = Ok ()

  let return_none = Ok None

  let return_some x = Ok (Some x)

  let return_nil = Ok []

  let return_true = Ok true

  let return_false = Ok false

  let ( let* ) = Result.bind

  let ( let+ ) v f = Result.map f v

  let rec join_errors errors = function
    | Ok _ :: ts -> join_errors errors ts
    | Error error :: ts -> join_errors (error :: errors) ts
    | [] -> Error errors

  let rec join = function
    | [] -> return_unit
    | Ok () :: ts -> join ts
    | Error error :: ts -> join_errors [error] ts

  let all ts =
    let rec aux acc = function
      | [] -> Ok (Stdlib.List.rev acc)
      | Ok v :: ts -> aux (v :: acc) ts
      | Error error :: ts -> join_errors [error] ts
    in
    aux [] ts

  let both a b =
    match (a, b) with
    | Ok a, Ok b -> Ok (a, b)
    | Error err, Ok _ | Ok _, Error err -> Error [err]
    | Error erra, Error errb -> Error [erra; errb]
end

module Lwt_option_syntax = struct
  let (return [@ocaml.inline "always"]) = fun x -> Lwt.return_some x

  let (fail [@ocaml.inline "always"]) = Lwt.return None

  let return_unit = Lwt_syntax.return_some ()

  let return_true = Lwt_syntax.return_some true

  let return_false = Lwt_syntax.return_some false

  let return_nil = Lwt_syntax.return_some []

  let both a b =
    let open Lwt_syntax in
    let+ a, b = both a b in
    Option_syntax.both a b

  let ( let* ) lo f = Lwt.bind lo (function None -> fail | Some x -> f x)

  let ( and* ) = both

  let ( let+ ) lo f = Lwt.map (Stdlib.Option.map f) lo

  let ( and+ ) = both

  let ( let*! ) = Lwt.bind

  let ( let*? ) o f = match o with Some x -> f x | None -> fail
end

module Lwt_result_syntax = struct
  let (return [@ocaml.inline "always"]) = fun x -> Lwt.return (Ok x)

  let (fail [@ocaml.inline "always"]) = fun x -> Lwt.return (Error x)

  let return_unit = Lwt_syntax.return_ok_unit

  let return_none = Lwt_syntax.return_ok_none

  let return_some x = Lwt.return (Ok (Some x))

  let return_true = Lwt_syntax.return_ok_true

  let return_false = Lwt_syntax.return_ok_false

  let return_nil = Lwt_syntax.return_ok_nil

  let ( let* ) = Lwt_result.bind

  let ( let+ ) v f = Lwt_result.map f v

  let lwt_map_error = Lwt_result.map_error

  let ( let*! ) = Lwt.bind

  let ( let*? ) r f =
    match r with Ok v -> f v | Error _ as err -> Lwt.return err

  let join ts =
    let open Lwt_syntax in
    let+ ps = all ts in
    Result_syntax.join ps

  let all ts =
    let open Lwt_syntax in
    let+ ps = all ts in
    Result_syntax.all ps

  let both a b =
    let open Lwt_syntax in
    let+ a, b = both a b in
    Result_syntax.both a b
end

(**/**)

(* For internal use only, not advertised *)

(* Like Lwt.apply but specialised for two-parameters functions *)
let (lwt_apply2 [@ocaml.inline "always"]) =
 fun f x y -> try f x y with exn -> Lwt.fail exn

let (lwt_apply3 [@ocaml.inline "always"]) =
 fun f a x y -> try f a x y with exn -> Lwt.fail exn
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