package octez-libs

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

Source file list.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
(*****************************************************************************)
(*                                                                           *)
(* 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 an exception-safe replacements for {!Stdlib.List}
    with Lwt- and result-aware traversal functions.

    See {!Lwtreslib}'s introductory documentation for explanations regarding
    [_e]-, [_s]-, [_es]-, [_p]-, and [_ep]-suffixed functions and exception
    safety. See {!Stdlib.Hashtbl.S} for explanations regarding OCaml's
    hashtables in general.

    Note that this signature is within the Traced part of the library. As a
    result, the [_ep] traversor returns en ['error trace]. *)
module type S = sig
  include Bare_sigs.List.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

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

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

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

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

  val partition_map_ep :
    ('a -> (('b, 'c) Either.t, 'error trace) result Lwt.t) ->
    'a list ->
    ('b list * 'c list, 'error trace) result Lwt.t

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

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

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

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

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

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

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

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

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

  val exists_ep :
    ('a -> (bool, 'error trace) result Lwt.t) ->
    'a list ->
    (bool, 'error trace) result Lwt.t
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