package containers

You can search for identifiers within the package.

in-package search v0.2.0

A modular, clean and powerful extension of the OCaml standard library

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (23)

Authors

C

c-cube

Maintainers

C

c-cube

Sources

containers-3.14.tbz

sha256=c94fba0c7c54349b7021c31f85120495197ddde438c574d48362ec669bf7e564

sha512=b33588d9df66a858083616cc70cd82822cecc2dcec8902759e72648e5c41c887556da0a28317f388d34afe319309c20dd8baa7508d003dddff00e83869fad861

doc/containers/CCEither/index.html

Module `CCEither`Source

Either Monad

Module that is compatible with Either form OCaml 4.12 but can be use with any ocaml version compatible with container

since 3.2

Sourcetype 'a iter = ('a -> unit) -> unit

Sourcetype 'a equal = 'a -> 'a -> bool

Sourcetype 'a ord = 'a -> 'a -> int

Sourcetype 'a printer = Format.formatter -> 'a -> unit

Basics

Sourcetype ('a, 'b) t = ('a, 'b) Either.t =

| Left of 'a
| Right of 'b

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

left l is Left l

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

right r is Right r

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

is_left x checks if x = Left _

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

is_right x checks if x = Right _

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

find_left x returns l if x = Left l and None otherwise.

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

find_right x returns r if x = Left r and None otherwise.

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

Map of the Left variant.

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

Map of the Right variant.

Source

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

Map using left or right.

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

Fold using left or right.

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

Iter using left or right.

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

Check some property on Left or Right variant.

Source

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

Source

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

IO

Sourceval pp : left:'a printer -> right:'b printer -> ('a, 'b) t printer

Pretty printer.

On This Page

Basics
IO

package containers

Install

Dune Dependency

Authors

Maintainers

Sources

doc/containers/CCEither/index.html

Module CCEitherSource

Basics

IO

Module `CCEither`Source