package travesty

Not available on OCaml 5.5
  1. Overview
  2. Docs
Traversable containers, monad extensions, and more

Install 

dune-project
 Dependency

mattwindsor91.github.io Readme Changelog Edit opam file Versions (6)

Authors

  1. M
    Matt Windsor <mattwindsor91@gmail.com>

Maintainers

  1. M
    Matt Windsor <mattwindsor91@gmail.com>

Sources

travesty-0.8.0.tbz
sha256=216c920c872cef2d52fa58e3c49826766a2cf6f2233e64937f18c46c0c5c5388
sha512=3b4f76794666aa3fb16c3639479790df3478a79e6f582b3e66b144e57df26a76580499961dd374f4fb6f3bd2dd7506e2725ed1242bada9deb14eb1916cacd18f

Description

'Travesty' is a library for defining containers with applicative or monadic traversals, inspired by Haskell's Traversable typeclass; it also contains various helpers for monadic code, such as state transformers and extension functions for common monads and containers. It sits on top of Jane Street's Base library and ecosystem.

Added to opam-repository:

README

Travesty

Main workflow

Travesty is a library for defining containers with applicative traversals, inspired by Haskell's Traversable typeclass. It sits on top of Jane Street's Base library.

Travesty also contains several other bits of Haskell-style applicative functor and monad functionality:

  • state monads (Travesty.State);
  • state transformers (Travesty.State_transform);
  • miscellaneous extensions on monads (Travesty.Monad_exts) and containers (Travesty.Containers_exts);
  • extensions and implementations of Travesty signatures for Base (Travesty_base_exts);
  • extra function combinators (Travesty_base_exts.Fn).

Note: the Travesty_base_exts modules form a separate subpackage (travesty.base_exts).

Travesty is licenced under the MIT licence, and is a spin-off from the c4f project.

NOTE: I (@MattWindsor91) am no longer actively working on travesty. As such, it will receive infrequent updates to keep it aligned with Base and OCaml, but not many more new features. Please feel free to file issues and pull requests, but be patient when waiting for responses!

Usage

See the API documentation.

Travesty tries not to shadow existing modules except in the various exts subpackages.

Contributions

Any and all contributions (pull requests, issues, etc.) are welcome.

Dependencies (4)

  1. base >= "v0.16.3" & < "v0.17"
  2. ppx_jane >= "v0.16.0"
  3. ocaml >= "5.1"
  4. dune >= "3.6"

Dev Dependencies (2)

  1. odoc with-doc
  2. ppx_expect with-test & >= "v0.16.0"

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building travesty with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.8.0 (this version) n/a n/a good n/a n/a
0.7.2 n/a good good n/a n/a
0.7.0 good good good n/a n/a
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure