simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-07 11:45:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

remove CCError from tutorial

Browse source
This commit is contained in:
Simon Cruanes 2017-02-11 14:51:02 +01:00
parent 283b34c3c6
commit c1980c2ead
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.adoc
View file

@ -215,7 +215,7 @@ map =
---- ----
=== New types: `CCVector`, `CCHeap`, `CCError`, `CCResult` === New types: `CCVector`, `CCHeap`, `CCResult`
Containers also contains (!) a few datatypes that are not from the standard Containers also contains (!) a few datatypes that are not from the standard
library but that are useful in a lot of situations: library but that are useful in a lot of situations:
@ -231,17 +231,13 @@ CCHeap::
A priority queue (currently, leftist heaps) functorized over A priority queue (currently, leftist heaps) functorized over
a module `sig val t val leq : t -> t -> bool` that provides a type `t` a module `sig val t val leq : t -> t -> bool` that provides a type `t`
and a partial order `leq` on `t`. and a partial order `leq` on `t`.
CCError::
An error type for making error handling more explicit (an error monad,
really, if you're not afraid of the "M"-word). It is similar to the
more recent `CCResult`, but works with polymorphic variants for
compatibility with the numerous libraries that use the same type,
that is, `type ('a, 'b) CCError.t = [`Ok of 'a | `Error of 'b]`.
CCResult:: CCResult::
An error type for making error handling more explicit (an error monad,
really, if you're not afraid of the "M"-word).
Subsumes and replaces the old `CCError`.
It uses the new `result` type from the standard library (or from It uses the new `result` type from the standard library (or from
the retrocompatibility package on opam), and presents an interface the retrocompatibility package on opam) and provides
similar to `CCError`. In an indeterminate amount of time, it will many combinators for dealing with `result`.
totally replace `CCError`.
Now for a few examples: Now for a few examples: