package travesty

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

Haskell-style state monads.

State monads are a way to thread a modifiable, readable state record through a computation without resorting to mutability. At any point in a state-monad computation, we can peek at the present value of the state, or modify it, or do both.

We provide two signatures for state monads: one corresponding to the situation where the state type is fixed at the module level (S), and one leaving the state type as part of the monad type (S2). The former has a corresponding make functor; the latter has a direct implementation.

We also provide a functor To_S for fixing the state type in an arity-2 monad after the fact.

Relation to state transformers

Like in Haskell, state monads are a special case of state transformers, corresponding to the application of those transformers to the identity monad.

If you need to run stateful computations that can fail, or are partial, or non-deterministic, and so on, use state transformers instead.

Signatures

State_intf contains the signatures for State.

include module type of State_intf
module type Generic = sig ... end

Generic contains the signature bits common to all state monad signatures.

module type S = sig ... end

S is the signature of state monads parametrised over their value, but with a fixed state type.

module type S2 = sig ... end

S2 is the signature of state monads parametrised over both value and state types.

Manipulating state monads

module To_S (M : S2) (B : Base.T) : S with type state = B.t and type 'a t = ('a, B.t) M.t

To_S flattens a S2 into an S by fixing the state type to B.t.

Implementations and functors

module Make (B : Base.T) : S with type state = B.t

Make makes an S (state monad with fixed state type) from a single state type.

module M2 : S2

M2 is a basic implementation of S2 (state monad with variable state type).

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