package preface

  1. Overview
  2. Docs
package preface
Legend:
Library
Module
Module type
Parameter
Class
Class type

A Traversable is a data structure that can be traversed from left to right, performing an action on each element.

A common usage of Traversable is to turn any Traversable of Applicative into a Applicative of Traversable.

For example, going to 'a option list to 'a list option.

Minimal definition

module type WITH_TRAVERSE = sig ... end

Minimal definition using traverse over a 'a iter.

Structure anatomy

module type CORE = WITH_TRAVERSE

Basis operations.

module type OPERATION = sig ... end

Additional operations.

Complete API

module type API = sig ... end

The complete interface of a Traversable

module type API_OVER_MONAD = sig ... end

The complete interface of a Traversable over a Monad

module type API_OVER_APPLICATIVE = sig ... end

The complete interface of a Traversable over an Applicative

Additional references

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct