Awesome
Gen
Iterators for OCaml, both restartable and consumable. The implementation keeps a good balance between simplicity and performance.
The library is extensively tested using qtest
. If you find a bug,
please report!
The documentation can be found here the main module is Gen and should suffice for 95% of use cases.
Native install
Installation in a native OCaml project, via opam:
$ opam install gen
or, manually, by building the library and running make install
. Opam is
recommended, for it keeps the library up-to-date.
BuckleScript install
Installation in JavaScript, via BuckleScript, in an npm project:
-
Install this package:
$ npm install bs-gen
-
Manually add
bs-gen
to yourbsconfig.json
'sbs-dependencies
:"bs-dependencies": [ ... "bs-gen" ],
Use
You can either build and install the library (see "Build"), or just copy files to your own project. The last solution has the benefits that you don't have additional dependencies nor build complications (and it may enable more inlining).
If you have comments, requests, or bugfixes, please share them! :-)
Build
There are no dependencies except for dune
for building. This should work with OCaml>=4.02
$ make
To build and run tests (requires oUnit
and qtest
):
$ opam install oUnit qtest
$ make test
License
This code is free, under the BSD license.