Result value combinators for OCaml
Switch branches/tags
Clone or download

README.md

Rresult — Result value combinators for OCaml

%%VERSION%%

Rresult is an OCaml module for handling computation results and errors in an explicit and declarative manner, without resorting to exceptions. It defines combinators to operate on the result type available from OCaml 4.03 in the standard library.

Rresult depends on the compatibility result package and is distributed under the ISC license.

Home page: http://erratique.ch/software/rresult
Contact: Daniel Bünzli <daniel.buenzl i@erratique.ch>

Installation

Rresult can be installed with opam:

opam install rresult

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online

Sample programs

If you installed Rresult with opam sample programs are located in the directory opam config var rresult:doc.

In the distribution sample programs and tests are located in the test directory of the distribution. They can be built and run with:

topkg build --tests true && topkg test