package alcotest
Build not yet checkedInstall
dune-project
Dependency
Authors
Maintainers
Sources
sha256=62c095deda5cdd66c30684f7b1f25b5775d1d3d3ded927c7b893b4a6834ddb47
sha512=6f779fa96faf96b5b462ddc428aeaaa73a6be96771dbbad6a05b7bb00dae246648891c211e26174729c1f40128410ad96f2512101ae8b7d61f968ee61534b3d0
doc/alcotest.stdlib_ext/Alcotest_stdlib_ext/Option/index.html
Module Alcotest_stdlib_ext.OptionSource
include module type of Option
Options
The type for option values. Either None or a value Some v.
none is None.
some v is Some v.
value o ~default is v if o is Some v and default otherwise.
get o is v if o is Some v and raise otherwise.
bind o f is f v if o is Some v and None if o is None.
join oo is Some v if oo is Some (Some v) and None otherwise.
map f o is None if o is None and Some (f v) if o is Some v.
product o0 o1 is Some (v0, v1) if o0 is Some v0 and o1 is Some v1 and None otherwise.
fold ~none ~some o is none if o is None and some v if o is Some v.
iter f o is f v if o is Some v and () otherwise.
blend f o1 o2 is o1 if o2 is None, o2 if o1 is None, and Some (f v1 v2) if o1 is Some v1 and o2 is Some v2.
for_all p behaves like List.for_all p on a list of zero or one element:
for_all p Noneistrue,for_all p (Some v)isp v.
exists p behaves like List.exists p on a list of zero or one element:
exists p Noneisfalse,exists p (Some v)isp v.
Predicates and comparisons
is_none o is true if and only if o is None.
is_some o is true if and only if o is Some o.
equal eq o0 o1 is true if and only if o0 and o1 are both None or if they are Some v0 and Some v1 and eq v0 v1 is true.
compare cmp o0 o1 is a total order on options using cmp to compare values wrapped by Some _. None is smaller than Some _ values.
Converting
to_result ~none o is Ok v if o is Some v and Error none otherwise.
to_list o is [] if o is None and [v] if o is Some v.
to_seq o is o as a sequence. None is the empty sequence and Some v is the singleton sequence containing v.