Module Stdlib.Either

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

Add the following to your project's dependencies/CMakeLists.txt:

Copy

DkSDKProject_DeclareAvailable(ocaml
    CONSTRAINT "= 4.14.0"
    FINDLIBS str unix runtime_events threads dynlink)
DkSDKProject_MakeAvailable(ocaml)

Add the Findlib::ocaml library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::ocaml)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install ocaml.4.14.0
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (ocaml (>= 4.14.0))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "ocaml" {>= "4.14.0"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    ))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    ))

type``('a, 'b) t`` =


| Left of 'a

| Right of 'b

A value of ('a, 'b) Either.t contains either a value of 'a or a value of 'b

valleft :'a -> ``('a, 'b)`` t

left v is Left v.

valright :'b -> ``('a, 'b)`` t

right v is Right v.

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

is_left (Left v) is true, is_left (Right v) is false.

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

is_right (Left v) is false, is_right (Right v) is true.

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

find_left (Left v) is Some v, find_left (Right _) is None

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

find_right (Right v) is Some v, find_right (Left _) is None

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

map_left f e is Left (f v) if e is Left v and e if e is Right _.

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

map_right f e is Right (f v) if e is Right v and e if e is Left _.

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

map ~left ~right (Left v) is Left (left v), map ~left ~right (Right v) is Right (right v).

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

fold ~left ~right (Left v) is left v, and fold ~left ~right (Right v) is right v.

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

iter ~left ~right (Left v) is left v, and iter ~left ~right (Right v) is right v.

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

for_all ~left ~right (Left v) is left v, and for_all ~left ~right (Right v) is right v.

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

equal ~left ~right e0 e1 tests equality of e0 and e1 using left and right to respectively compare values wrapped by Left _ and Right _.

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

compare ~left ~right e0 e1 totally orders e0 and e1 using left and right to respectively compare values wrapped by Left _ and Right _. Left _ values are smaller than Right _ values.

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. 1. Module Capnp
    1. 1. Module type MessageSig.MESSAGE
        Module type MessageSig.S
        Module S.ListStorage
        Module S.Message
        Module S.Object
        Module S.Segment
        Module S.Slice
        Module S.StructStorage
        Module type MessageSig.SEGMENT
        Module type MessageSig.SLICE
    1. Module Capnp_unix
  1. Package cmdliner
  1. 1. Module Cmdliner
    1. Module Cmdliner_arg
    1. Module Cmdliner_base
    1. Module Cmdliner_cline
    1. Module Cmdliner_cmd
    1. Module Cmdliner_docgen
    1. Module Cmdliner_eval
    1. Module Cmdliner_info
    1. Module Cmdliner_manpage
    1. Module Cmdliner_msg
    1. Module Cmdliner_term
    1. Module Cmdliner_term_deprecated
    1. Module Cmdliner_trie
  1. Package fmt
  1. 1. Module Fmt
    1. Module Fmt_cli
    1. Module Fmt_tty
  1. Package logs
  1. 1. Module Logs
    1. 1. Module type Logs.LOG
      1. ...
    1. Module Logs_cli
    1. Module Logs_fmt
    1. Module Logs_lwt
    1. 1. Module type Logs_lwt.LOG
    1. Module Logs_threaded
  1. Package lwt
  1. 1. Module Lwt
    1. Module Lwt_bytes
    1. Module Lwt_condition
    1. Module Lwt_config
    1. Module Lwt_engine
    1. Module Lwt_features
    1. Module Lwt_fmt
    1. Module Lwt_gc
    1. Module Lwt_io
    1. 1. Module type Lwt_io.NumberIO
    1. Module Lwt_list
    1. Module Lwt_main
    1. 1. Module type Lwt_main.Hooks
    1. Module Lwt_mutex
    1. Module Lwt_mvar
    1. Module Lwt_pool
    1. Module Lwt_pqueue
    1. 1. Module type Lwt_pqueue.OrderedType
        Module type Lwt_pqueue.S
    1. Module Lwt_preemptive
    1. Module Lwt_process
    1. Module Lwt_result
    1. Module Lwt_seq
    1. Module Lwt_sequence
    1. Module Lwt_stream
    1. Module Lwt_switch
    1. Module Lwt_sys
    1. Module Lwt_throttle
    1. 1. Module type Lwt_throttle.S
    1. Module Lwt_timeout
    1. Module Lwt_unix
  1. Package mtime
  1. 1. Module Mtime
    1. Module Mtime_clock
  1. Package ocaml
  1. 1. Module Bigarray
    1. Module Condition
    1. Module Dynlink
    1. Module Event
    1. Module Mutex
    1. Module Profiling
    1. Module Semaphore
    1. Module Stdlib
    1. 1. ...
      1. Module Stdlib.Either
    1. Module Str
    1. Module Thread
    1. Module ThreadUnix
    1. Module Topdirs
    1. Module Unix
    1. Module UnixLabels
  1. Package
  1. Package result
  1. 1. Module Result
  1. Package stdint
  1. 1. Module Stdint
    1. 1. Module type Stdint.Int