package algaeff

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

The implementation of the effects.

Signatures of the effects.

Parameters

module P : Param

include Param with type elt = P.elt

type elt = P.elt

The type of elements.

module ID : sig ... end

The type of IDs and its friends.

type id = ID.t

The type of unique IDs. The client should not assume a particular indexing scheme.

val register : elt -> id

Register a new item and get an ID. Note that registering the same item twice will get two different IDs.

val retrieve : id -> elt

Retrieve the item associated with the ID.

val export : unit -> elt Seq.t

Export the internal storage for serialization. Once exported, the representation is persistent and can be traversed without the effect handler.

val run : ?init:elt Seq.t -> (unit -> 'a) -> 'a

run t runs the thunk t and handles the effects for generating unique IDs.

parameter init
The initial storage, which should be the output of some previous export.