raphael-proust/result

Declarative error handling for OCaml (unreleased)

Result — Declarative error handling for OCaml

Release %%VERSION%%

Result is an OCaml module for handling errors without resorting to exceptions. It defines a result type and combinators to operate on these values.

Result has no dependency and is distributed under the BSD3 license.

Home page: http://erratique.ch/software/result
Contact: Daniel Bünzli <daniel.buenzl [email protected]>

Installation

Result can be installed with opam:

opam install result

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 and there is a generated version in the doc directory of the distribution.

Sample programs

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

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

ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in _build/test.

• test.native tests the library, nothing should fail.