package preface

  1. Overview
  2. Docs

Module Shims.EitherSource

Sourcetype ('a, 'b) t = ('a, 'b) Either.t =
  1. | Left of 'a
  2. | Right of 'b

This module defines the common Either interface that is provided for all OCaml versions. For documentation of these functions, refer to the standard library.

Sourceval left : 'a -> ('a, 'b) t
Sourceval right : 'b -> ('a, 'b) t
Sourceval is_left : ('a, 'b) t -> bool
Sourceval is_right : ('a, 'b) t -> bool
Sourceval find_left : ('a, 'b) t -> 'a option
Sourceval find_right : ('a, 'b) t -> 'b option
Sourceval map_left : ('a1 -> 'a2) -> ('a1, 'b) t -> ('a2, 'b) t
Sourceval map_right : ('b1 -> 'b2) -> ('a, 'b1) t -> ('a, 'b2) t
Sourceval map : left:('a1 -> 'a2) -> right:('b1 -> 'b2) -> ('a1, 'b1) t -> ('a2, 'b2) t
Sourceval fold : left:('a -> 'c) -> right:('b -> 'c) -> ('a, 'b) t -> 'c
Sourceval iter : left:('a -> unit) -> right:('b -> unit) -> ('a, 'b) t -> unit
Sourceval for_all : left:('a -> bool) -> right:('b -> bool) -> ('a, 'b) t -> bool
Sourceval equal : left:('a -> 'a -> bool) -> right:('b -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t -> bool
Sourceval compare : left:('a -> 'a -> int) -> right:('b -> 'b -> int) -> ('a, 'b) t -> ('a, 'b) t -> int
Sourceval case : ('a -> 'c) -> ('b -> 'c) -> ('a, 'b) t -> 'c

case f g x conditionally perform f or g on x.

Sourceval swap : ('a, 'b) t -> ('b, 'a) t

swap x transforms Left x into Right x and Right x into Left x