package algaeff

You can search for identifiers within the package.

in-package search v0.2.0

algaeff
- Algaeff
  - Fun
    
    Deep
    
    Shallow
  - Mutex
    
    Make
    
    S
  - Reader
    
    Make
    
    P
    
    Param
    
    S
  - Sequencer
    
    Make
    
    P
    
    Param
    
    S
  - State
    
    Make
    
    P
    
    Param
    
    S
  - UniqueID
    
    Make
    
    ID
    
    P
    
    Param
    
    S
    
    ID
  - Unmonad
    
    Make
    
    M
    
    Monad
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

Effects for changing states.

module S = Algaeff.State.Make (struct type state = int end)

let forty_two = S.run ~init:100 @@ fun () ->
  print_int (S.get ()); (* this will print out 100 *)
  S.set 42;
  S.get ()

This should be equivalent to Unmonad applying to the standard state monad when continuations are one-shot. (The current implementation uses mutable references and this statement has not been formally proved.)

module type Param = sig ... end

Parameters of state effects.

module type S = sig ... end

Signatures of read effects.

module Make (P : Param) : S with type state = P.state

The implementation of state effects.