package octez-libs

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

Source file seq_es.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
(*****************************************************************************)
(*                                                                           *)
(* 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

(** The [S] signature is similar to {!Seq.S} except that suspended nodes are
    wrapped in a result-Lwt.

    This allows some additional traversors ([ES.map], etc.) to be applied
    lazily.

    The functions [of_seq] and [of_seq_*] allow conversion from vanilla
    sequences. *)
module type S = sig
  type ('a, 'e) seq_e_t (* For substitution by [Seq_e.t] *)

  type 'a seq_s_t (* For substitution by [Seq_s.t] *)

  (** This is similar to {!Seq.S}[.t] but the suspended node is a promised
      result.

      Similarly to [Seq_e], sequences of this module can be interrupted by an
      error. In this case, traversal has fully applied to the successful prefix
      before the returned promise evaluates to [Error _].
   *)
  type (+'a, 'e) node = Nil | Cons of 'a * ('a, 'e) t

  and ('a, 'e) t = unit -> (('a, 'e) node, 'e) result Lwt.t

  include
    Seqes.Sigs.SEQMON2ALL
      with type ('a, 'e) mon := ('a, 'e) result Lwt.t
      with type ('a, 'e) t := ('a, 'e) t

  module E :
    Seqes.Sigs.SEQMON2TRANSFORMERS
      with type ('a, 'e) mon := ('a, 'e) result Lwt.t
      with type ('a, 'e) callermon := ('a, 'e) result
      with type ('a, 'e) t := ('a, 'e) t

  module S :
    Seqes.Sigs.SEQMON2TRANSFORMERS
      with type ('a, 'e) mon := ('a, 'e) result Lwt.t
      with type ('a, 'e) callermon := 'a Lwt.t
      with type ('a, 'e) t := ('a, 'e) t

  module ES :
    Seqes.Sigs.SEQMON2TRANSFORMERS
      with type ('a, 'e) mon := ('a, 'e) result Lwt.t
      with type ('a, 'e) callermon := ('a, 'e) result Lwt.t
      with type ('a, 'e) t := ('a, 'e) t

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

  val cons_e : ('a, 'e) result -> ('a, 'e) t -> ('a, 'e) t

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

  val return_e : ('a, 'e) result -> ('a, 'e) t

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

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

  val interrupted : 'e -> ('a, 'e) t

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

  val map_error : ('e -> 'f) -> ('a, 'e) t -> ('a, 'f) t

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

  val take :
    when_negative_length:'err -> int -> ('a, 'e) t -> (('a, 'e) t, 'err) result

  val drop :
    when_negative_length:'err -> int -> ('a, 'e) t -> (('a, 'e) t, 'err) result

  val of_seq : 'a Stdlib.Seq.t -> ('a, 'e) t

  val of_seq_s : 'a Lwt.t Stdlib.Seq.t -> ('a, 'e) t

  val of_seqs : 'a seq_s_t -> ('a, 'e) t

  val of_seq_e : ('a, 'e) result Stdlib.Seq.t -> ('a, 'e) t

  val of_seqe : ('a, 'e) seq_e_t -> ('a, 'e) t

  val of_seq_es : ('a, 'e) result Lwt.t Stdlib.Seq.t -> ('a, 'e) 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