package tezos-lwt-result-stdlib

You can search for identifiers within the package.

in-package search v0.2.0

Tezos: error-aware stdlib replacement

Install

Dune Dependency

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

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-v10.2.tar.bz2

sha256=6b33e0549574c89a63538c94ce5555dd141e3c0fb5d934abff07d702fa3244d2

sha512=681a197baabec6e2f806871d43490382243207518f8fcf932741cd314d8717e46db2b6a5adc222f8726083a5dd911083b4931b7e878ab815f8f1a32763d1bf93

doc/bare_structs/Bare_structs/Seq/index.html

Module `Bare_structs.Seq`

include Bare_sigs.Seq.S

Common interface with Stdlib

include module type of Stdlib.Seq
  with type 'a t = 'a Stdlib.Seq.t
   and type 'a node = 'a Stdlib.Seq.node

type !'a t = 'a Stdlib.Seq.t

and !'a node = 'a Stdlib.Seq.node =

| Nil
| Cons of 'a * 'a t

val empty : 'a t

val return : 'a -> 'a t

val map : ('a -> 'b) -> 'a t -> 'b t

val filter : ('a -> bool) -> 'a t -> 'a t

val filter_map : ('a -> 'b option) -> 'a t -> 'b t

val flat_map : ('a -> 'b t) -> 'a t -> 'b t

val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a

val iter : ('a -> unit) -> 'a t -> unit

Some values that made it to Stdlib's Seq since

val cons : 'a -> 'a t -> 'a t

val append : 'a t -> 'a t -> 'a t

Lwtreslib-specific extensions

val first : 'a t -> 'a option

first s is None if s is empty, it is Some x where x is the first element of s otherwise.

Note that first forces the first element of the sequence, which can have side-effects or be computationally expensive. Consider, e.g., the case where s = filter (fun …) s': first s can force multiple of the values from s'.

val fold_left_e : 
  ('a -> 'b -> ('a, 'trace) Stdlib.result) ->
  'a ->
  'b t ->
  ('a, 'trace) Stdlib.result

Similar to fold_left but wraps the traversal in result. The traversal is interrupted if one of the step returns an Error _.

val fold_left_s : ('a -> 'b -> 'a Lwt.t) -> 'a -> 'b t -> 'a Lwt.t

Similar to fold_left but wraps the traversing in Lwt. Each step of the traversal is started after the previous one has resolved. The traversal is interrupted if one of the promise is rejected.

val fold_left_es : 
  ('a -> 'b -> ('a, 'trace) Stdlib.result Lwt.t) ->
  'a ->
  'b t ->
  ('a, 'trace) Stdlib.result Lwt.t

Similar to fold_left but wraps the traversing in result Lwt.t. Each step of the traversal is started after the previous one resolved. The traversal is interrupted if one of the step is rejected or is fulfilled with Error _.

val iter_e : 
  ('a -> (unit, 'trace) Stdlib.result) ->
  'a t ->
  (unit, 'trace) Stdlib.result

Similar to iter but wraps the iteration in result. The iteration is interrupted if one of the step returns an Error _.

val iter_s : ('a -> unit Lwt.t) -> 'a t -> unit Lwt.t

Similar to iter but wraps the iteration in Lwt. Each step of the iteration is started after the previous one resolved. The iteration is interrupted if one of the promise is rejected.

val iter_es : 
  ('a -> (unit, 'trace) Stdlib.result Lwt.t) ->
  'a t ->
  (unit, 'trace) Stdlib.result Lwt.t

Similar to iter but wraps the iteration in result Lwt.t. Each step of the iteration is started after the previous one resolved. The iteration is interrupted if one of the promise is rejected of fulfilled with an Error _.

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

Similar to iter but wraps the iteration in result Lwt.t. All the steps of the iteration are started concurrently. The promise iter_ep resolves once all the promises of the traversal resolve. At this point it either:

is rejected if at least one of the promises is, otherwise
is fulfilled with Error _ if at least one of the promises is, otherwise
is fulfilled with Ok () if all the promises are.

val iter_p : ('a -> unit Lwt.t) -> 'a t -> unit Lwt.t

Similar to iter but wraps the iteration in Lwt. All the steps of the iteration are started concurrently. The promise iter_p f s is resolved only once all the promises of the iteration are. At this point it is either fulfilled if all promises are, or rejected if at least one of them is.

val unfold : ('b -> ('a * 'b) option) -> 'b -> 'a t