package base

  1. Overview
  2. Docs
package base
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ('f, 's) t =
  1. | First of 'f
  2. | Second of 's

This type represents values with two possibilities. Either can be seen as a generic sum type, the dual of Tuple. First is neither more important nor less important than Second.

include sig ... end
val t_of_sexp : (Sexp.t -> 'f) -> (Sexp.t -> 's) -> Sexp.t -> ('f, 's) t
val sexp_of_t : ('f -> Sexp.t) -> ('s -> Sexp.t) -> ('f, 's) t -> Sexp.t
val hash_fold_t : (Hash.state -> 'f -> Hash.state) -> (Hash.state -> 's -> Hash.state) -> Hash.state -> ('f, 's) t -> Hash.state
val compare : ('f -> 'f -> int) -> ('s -> 's -> int) -> ('f, 's) t -> ('f, 's) t -> int
include Invariant.S2 with type ('a, 'b) t := ('a, 'b) t
val invariant : ('a -> unit) -> ('b -> unit) -> ('a, 'b) t -> unit
val swap : ('f, 's) t -> ('s, 'f) t
val value : ('a, 'a) t -> 'a
val iter : ('a, 'b) t -> first:('a -> unit) -> second:('b -> unit) -> unit
val value_map : ('a, 'b) t -> first:('a -> 'c) -> second:('b -> 'c) -> 'c
val map : ('a, 'b) t -> first:('a -> 'c) -> second:('b -> 'd) -> ('c, 'd) t
val equal : ('f -> 'f -> bool) -> ('s -> 's -> bool) -> ('f, 's) t -> ('f, 's) t -> bool
module First : Either_intf.Focused with type ('a, 'b) t = ('a, 'b) t
module Second : Either_intf.Focused with type ('a, 'b) t = ('b, 'a) t
val is_first : (_, _) t -> bool
val is_second : (_, _) t -> bool
val first : 'f -> ('f, _) t

first and second are First.return and Second.return.

val second : 's -> (_, 's) t
module Export : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct