package tezos-lwt-result-stdlib

  1. Overview
  2. Docs
package tezos-lwt-result-stdlib
Legend:
Library
Module
Module type
Parameter
Class
Class type

Sets with the signature S are exception-safe replacements for sets with the Stdlib.Set.S signature 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.Set.S for explanations regarding OCaml's sets in general.

Note that this signature is within the Traced part of the library. As a result, the _ep traversor returns en 'error trace.

include Bare_functor_outputs.Set.S
type elt
type t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val disjoint : t -> t -> bool
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val iter_e : (elt -> (unit, 'trace) result) -> t -> (unit, 'trace) result
val iter_s : (elt -> unit Lwt.t) -> t -> unit Lwt.t
val iter_p : (elt -> unit Lwt.t) -> t -> unit Lwt.t
val iter_es : (elt -> (unit, 'trace) result Lwt.t) -> t -> (unit, 'trace) result Lwt.t
val map : (elt -> elt) -> t -> t
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val fold_e : (elt -> 'a -> ('a, 'trace) result) -> t -> 'a -> ('a, 'trace) result
val fold_s : (elt -> 'a -> 'a Lwt.t) -> t -> 'a -> 'a Lwt.t
val fold_es : (elt -> 'a -> ('a, 'trace) result Lwt.t) -> t -> 'a -> ('a, 'trace) result Lwt.t
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val filter_map : (elt -> elt option) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt option
val min_elt_opt : t -> elt option
val max_elt : t -> elt option
val max_elt_opt : t -> elt option
val choose : t -> elt option
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt option
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt option
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt option
val find_last_opt : (elt -> bool) -> t -> elt option
val of_list : elt list -> t
val to_seq_from : elt -> t -> elt Seq.t
val to_seq : t -> elt Seq.t
val to_rev_seq : t -> elt Seq.t
val add_seq : elt Seq.t -> t -> t
val of_seq : elt Seq.t -> t
type 'error trace

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

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