package tezos-lwt-result-stdlib

  1. Overview
  2. Docs
Tezos: error-aware stdlib replacement

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-v10.2.tar.bz2
sha256=6b33e0549574c89a63538c94ce5555dd141e3c0fb5d934abff07d702fa3244d2
sha512=681a197baabec6e2f806871d43490382243207518f8fcf932741cd314d8717e46db2b6a5adc222f8726083a5dd911083b4931b7e878ab815f8f1a32763d1bf93

doc/bare_structs/Bare_structs/Option/index.html

Module Bare_structs.Option

include Bare_sigs.Option.S
type 'a t = 'a option =
  1. | None
  2. | Some of 'a
val none : 'a option
val none_e : ('a option, 'trace) Stdlib.result
val none_s : 'a option Lwt.t
val none_es : ('a option, 'trace) Stdlib.result Lwt.t
val some : 'a -> 'a option
val some_unit : unit option
val some_unit_e : (unit option, 'error) Stdlib.result
val some_unit_s : unit option Lwt.t
val some_unit_es : (unit option, 'error) Stdlib.result Lwt.t
val some_nil : 'a list option
val some_nil_e : ('a list option, 'error) Stdlib.result
val some_nil_s : 'a list option Lwt.t
val some_nil_es : ('a list option, 'error) Stdlib.result Lwt.t
val some_true : bool option
val some_true_e : (bool option, 'error) Stdlib.result
val some_true_s : bool option Lwt.t
val some_true_es : (bool option, 'error) Stdlib.result Lwt.t
val some_false : bool option
val some_false_e : (bool option, 'error) Stdlib.result
val some_false_s : bool option Lwt.t
val some_false_es : (bool option, 'error) Stdlib.result Lwt.t
val some_e : 'a -> ('a option, 'trace) Stdlib.result
val some_s : 'a -> 'a option Lwt.t
val some_es : 'a -> ('a option, 'trace) Stdlib.result Lwt.t
val value : 'a option -> default:'a -> 'a
val value_e : 'a option -> error:'trace -> ('a, 'trace) Stdlib.result
val value_f : 'a option -> default:(unit -> 'a) -> 'a
val value_fe : 'a option -> error:(unit -> 'trace) -> ('a, 'trace) Stdlib.result
val bind : 'a option -> ('a -> 'b option) -> 'b option
val join : 'a option option -> 'a option
val either : 'a option -> 'a option -> 'a option

either picks the first Some _ value of its arguments if any. More formally, either (Some x) _ is Some x, either None (Some y) is Some y, and either None None is None.

val either_f : 'a option -> (unit -> 'a option) -> 'a option
val merge : ('a -> 'a -> 'a) -> 'a option -> 'a option -> 'a option
val merge_e : ('a -> 'a -> ('a, 'e) Stdlib.result) -> 'a option -> 'a option -> ('a option, 'e) Stdlib.result
val merge_s : ('a -> 'a -> 'a Lwt.t) -> 'a option -> 'a option -> 'a option Lwt.t
val merge_es : ('a -> 'a -> ('a, 'e) Stdlib.result Lwt.t) -> 'a option -> 'a option -> ('a option, 'e) Stdlib.result Lwt.t
val map : ('a -> 'b) -> 'a option -> 'b option
val map_s : ('a -> 'b Lwt.t) -> 'a option -> 'b option Lwt.t
val map_e : ('a -> ('b, 'trace) Stdlib.result) -> 'a option -> ('b option, 'trace) Stdlib.result
val map_es : ('a -> ('b, 'trace) Stdlib.result Lwt.t) -> 'a option -> ('b option, 'trace) Stdlib.result Lwt.t
val fold : none:'a -> some:('b -> 'a) -> 'b option -> 'a
val fold_s : none:'a -> some:('b -> 'a Lwt.t) -> 'b option -> 'a Lwt.t
val fold_f : none:(unit -> 'a) -> some:('b -> 'a) -> 'b option -> 'a
val filter : ('a -> bool) -> 'a option -> 'a option

filter p o is Some x iff o is Some x and p o is true.

In other words, filter is like List.filter if option is the type of lists of either zero or one elements. In fact, the following equality holds for all p and for all o: Option.filter p o = List.hd (List.filter p (Option.to_list o))

The other filter variants below are also equivalent to their List counterpart and a similar equality holds.

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

filter_map is the Option counterpart to List's filter_map. Incidentally, filter_map f o is also bind o f.

val filter_s : ('a -> bool Lwt.t) -> 'a option -> 'a option Lwt.t

filter_s is filter where the predicate returns a promise.

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

filter_map_s is filter_map where the function returns a promise.

val filter_e : ('a -> (bool, 'e) Stdlib.result) -> 'a option -> ('a option, 'e) Stdlib.result

filter_e is filter where the predicate returns a result.

val filter_map_e : ('a -> ('b option, 'e) Stdlib.result) -> 'a option -> ('b option, 'e) Stdlib.result

filter_map_e is filter_map where the function returns a result.

val filter_es : ('a -> (bool, 'e) Stdlib.result Lwt.t) -> 'a option -> ('a option, 'e) Stdlib.result Lwt.t

filter_es is filter where the predicate returns a promise of a result.

val filter_map_es : ('a -> ('b option, 'e) Stdlib.result Lwt.t) -> 'a option -> ('b option, 'e) Stdlib.result Lwt.t

filter_map_es is filter_map where the function returns a promise of a result.

val filter_ok : ('a, 'e) Stdlib.result option -> 'a option

filter_ok o is Some x iff o is Some (Ok x).

val filter_error : ('a, 'e) Stdlib.result option -> 'e option

filter_error o is Some x iff o is Some (Error x).

val iter : ('a -> unit) -> 'a option -> unit
val iter_s : ('a -> unit Lwt.t) -> 'a option -> unit Lwt.t
val iter_e : ('a -> (unit, 'trace) Stdlib.result) -> 'a option -> (unit, 'trace) Stdlib.result
val iter_es : ('a -> (unit, 'trace) Stdlib.result Lwt.t) -> 'a option -> (unit, 'trace) Stdlib.result Lwt.t
val is_none : 'a option -> bool
val is_some : 'a option -> bool
val equal : ('a -> 'a -> bool) -> 'a option -> 'a option -> bool
val compare : ('a -> 'a -> int) -> 'a option -> 'a option -> int
val to_result : none:'trace -> 'a option -> ('a, 'trace) Stdlib.result
val of_result : ('a, 'e) Stdlib.result -> 'a option
val to_list : 'a option -> 'a list
val to_seq : 'a option -> 'a Stdlib.Seq.t