package rresult
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=db4847751877908fe094b8b8fd78576c654759daabd893a426b53ef152b8658c
md5=8f47a03cd17b5e9fefd5f07a731a66e8
README.md.html
Rresult — Result value combinators for OCaml
Release 0.3.0
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 BSD3 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 and there is a generated version in the doc
directory of the distribution.
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 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.