模块 Either

module Either: sig .. end

Either 类型。

Either 是最简单和最通用的和/或类型：一个 ('a, 'b) Either.t 类型的值要么是一个 Left (v : 'a)，要么是一个 Right (v : 'b)。

在通用函数的 API 中，当值可能属于两种不同的情况（可能具有不同的类型）并且没有为每种情况分配特定的含义时，它是一个自然的选择。

例如

List.partition_map:
    ('a -> ('b, 'c) Either.t) -> 'a list -> 'b list * 'c list

如果您正在寻找一种参数化类型，其中一个备选方案表示成功，另一个备选方案表示失败，则应使用更具体的类型 Result.t。

type ('a, 'b) t =
| Left of 'a
| Right of 'b

一个 ('a, 'b) Either.t 类型的值包含一个 'a 类型的值或一个 'b 类型的值。

val left : 'a -> ('a, 'b) t

left v 等于 Left v。

val right : 'b -> ('a, 'b) t

right v 等于 Right v。

val is_left : ('a, 'b) t -> bool

is_left (Left v) 等于 true，is_left (Right v) 等于 false。

val is_right : ('a, 'b) t -> bool

is_right (Left v) 等于 false，is_right (Right v) 等于 true。

val find_left : ('a, 'b) t -> 'a option

find_left (Left v) 等于 Some v，find_left (Right _) 等于 None

val find_right : ('a, 'b) t -> 'b option

find_right (Right v) 等于 Some v，find_right (Left _) 等于 None

val map_left : ('a1 -> 'a2) -> ('a1, 'b) t -> ('a2, 'b) t

map_left f e 如果 e 等于 Left v 则等于 Left (f v)，如果 e 等于 Right _ 则等于 e。

val map_right : ('b1 -> 'b2) -> ('a, 'b1) t -> ('a, 'b2) t

map_right f e 如果 e 等于 Right v 则等于 Right (f v)，如果 e 等于 Left _ 则等于 e。

val map : left:('a1 -> 'a2) ->
       right:('b1 -> 'b2) -> ('a1, 'b1) t -> ('a2, 'b2) t

map ~left ~right (Left v) 等于 Left (left v)，map ~left ~right (Right v) 等于 Right (right v)。

val fold : left:('a -> 'c) -> right:('b -> 'c) -> ('a, 'b) t -> 'c

fold ~left ~right (Left v) 等于 left v，fold ~left ~right (Right v) 等于 right v。

val iter : left:('a -> unit) -> right:('b -> unit) -> ('a, 'b) t -> unit

iter ~left ~right (Left v) 等于 left v，iter ~left ~right (Right v) 等于 right v。

val for_all : left:('a -> bool) -> right:('b -> bool) -> ('a, 'b) t -> bool

for_all ~left ~right (Left v) 等于 left v，for_all ~left ~right (Right v) 等于 right v。

val equal : left:('a -> 'a -> bool) ->
       right:('b -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t -> bool

equal ~left ~right e0 e1 使用 left 和 right 分别比较由 Left _ 和 Right _ 包裹的值来测试 e0 和 e1 的相等性。

val compare : left:('a -> 'a -> int) ->
       right:('b -> 'b -> int) -> ('a, 'b) t -> ('a, 'b) t -> int

compare ~left ~right e0 e1 使用 left 和 right 分别比较由 Left _  和 Right _ 包裹的值来完全排序 e0 和 e1。Left _ 值小于 Right _ 值。