模块 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 ~default 如果 oSome v 则返回 v,否则返回 default

val get : 'a option -> 'a

get o 如果 oSome v 则返回 v,否则抛出异常。

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

bind o f 如果 oSome v 则返回 f v,如果 oNone 则返回 None

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

join oo 如果 ooSome (Some v) 则返回 Some v,否则返回 None

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

map f o 如果 oNone 则返回 None,如果 oSome v 则返回 Some (f v)

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

fold ~none ~some o 如果 oNone 则返回 none,如果 oSome v 则返回 some v

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

iter f o 如果 oSome 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 v1eq 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 o 如果 oSome v 则返回 Ok v,否则返回 Error none

val to_list : 'a option -> 'a list

to_list o 如果 oNone 则返回 [],如果 oSome v 则返回 [v]

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

to_seq oo 转换为一个序列。 None 是空序列, Some v 是包含 v 的单元素序列。