模組 Stdlib.Option

module Option: Option

選項

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 ~defaultoSome v 則為 v,否則為 default

val get : 'a option -> 'a

get ooSome v 則為 v,否則拋出例外。

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

bind o foSome v 則為 f v,若 oNone 則為 None

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

join ooooSome (Some v) 則為 Some v,否則為 None

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

map f ooNone 則為 None,若 oSome v 則為 Some (f v)

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

fold ~none ~some ooNone 則為 none,若 oSome v 則為 some v

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

iter f ooSome v 則為 f v,否則為 ()

述詞與比較

val is_none : 'a option -> bool

is_none o 若且唯若 oNone 時為 true

val is_some : 'a option -> bool

is_some o 若且唯若 oSome o 時為 true

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

equal eq o0 o1 若且唯若 o0o1 皆為 None,或者它們為 Some v0Some v1,且 eq v0 v1true 時,則為 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 ooSome v 則為 Ok v,否則為 Error none

val to_list : 'a option -> 'a list

to_list ooNone 則為 [],若 oSome v 則為 [v]

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

to_seq oo 作為序列。None 是空序列,而 Some v 是包含 v 的單元素序列。