package eliom

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

Simple interface for persistent references. Relies on Stdlib.Marshal for (de)serialisation, which entails the same limitations as for the Polymorphic frontend. If this is an issue you can rely on Functorial frontend instead (see TABLE.Variable).

Persistent references for OCaml

type 'a t

The type of (persistent or not) references

val ref : ?persistent:string -> 'a -> 'a t

ref ?persistent default creates a reference. If optional parameter ?persistent is absent,

  1. the reference will not be persistent (implemented using OCaml references).
  2. Otherwise, the value of persistent will be used as key for the
  3. value in the persistent reference table. If the reference already exists, the current value is kept.
  4. Be careful to change this name every time you change the type of the
  5. value.
val get : 'a t -> 'a Lwt.t

Get the value of a reference

val set : 'a t -> 'a -> unit Lwt.t

Set the value of a reference

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