gen

Iterators for OCaml, both restartable and consumable
README

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.

Changelog

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:

  1. Install this package:

    $ npm install bs-gen
    
  2. Manually add bs-gen to your bsconfig.json's bs-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.

Install
Sources
v1.0.tar.gz
md5=4386c7e64963619d660417175b84288d
sha512=fb4ec2ab35a1aba0dcc8439b11f14a0a785d939f661f505aec88a6f2ca6ca87e14ddfda860d9c180b215190b76690de87040c144582f069224f7e58d37ef48a0
Dependencies
ocaml
>= "4.03.0"
ounit2
with-test
qtest
with-test
qcheck
with-test
odoc
with-doc
dune
>= "1.1"
Reverse Dependencies