模組 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 的單例序列。