Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package traits
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Module Traits.OptionSource
Standard traits implementations for option
It includes Stdlib's Option to be able to open Traits without losing access to Option
include module type of struct include Option end
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.
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.
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.