模块 Option

module Option: sig .. end

选项值。

选项值明确指示某个值的存在或不存在。

选项

type 'a t = 'a option =
| None
| Some of 'a

选项值的类型。要么是 None，要么是值 Some v。

val none : 'a option

none 等于 None。

val some : 'a -> 'a option

some v 等于 Some v。

val value : 'a option -> default:'a -> 'a

value o ~default 如果 o 是 Some v 则为 v，否则为 default。

val get : 'a option -> 'a

get o 如果 o 是 Some v 则为 v，否则抛出异常。

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

bind o f 如果 o 是 Some v 则为 f v，如果 o 是 None 则为 None。

val join : 'a option option -> 'a option

join oo 如果 oo 是 Some (Some v) 则为 Some v，否则为 None。

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

map f o 如果 o 是 None 则为 None，如果 o 是 Some v 则为 Some (f v)。

val fold : none:'a -> some:('b -> 'a) -> 'b option -> 'a

fold ~none ~some o 如果 o 是 None 则为 none，如果 o 是 Some v 则为 some v。

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

iter f o 如果 o 是 Some v 则为 f v，否则为 ()。

谓词和比较

val is_none : 'a option -> bool

is_none o 当且仅当 o 是 None 时为 true。

val is_some : 'a option -> bool

is_some o 当且仅当 o 是 Some o 时为 true。

val equal : ('a -> 'a -> bool) -> 'a option -> 'a option -> bool

equal eq o0 o1 当且仅当 o0 和 o1 都为 None，或者它们分别为 Some v0 和 Some v1 且 eq v0 v1 为 true 时为 true。

val compare : ('a -> 'a -> int) -> 'a option -> 'a option -> int

compare cmp o0 o1 是使用 cmp 比较由 Some _ 包裹的值的选项的总排序。 None 小于 Some _ 值。

转换

val to_result : none:'e -> 'a option -> ('a, 'e) result

to_result ~none o 如果 o 是 Some v 则为 Ok v，否则为 Error none。

val to_list : 'a option -> 'a list

to_list o 如果 o 是 None 则为 []，如果 o 是 Some v 则为 [v]。

val to_seq : 'a option -> 'a Seq.t

to_seq o 是 o 作为序列。 None 是空序列，Some v 是包含 v 的单元素序列。