package irmin

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include AO

Append-only stores

include RO

Read-only stores

type t

Type for stores.

type key

Type for keys.

type value

Type for values.

val read : t -> key -> value option Lwt.t

Read a value from the store.

val read_exn : t -> key -> value Lwt.t

Same as read but raise Invalid_argument if the key does not exist.

val mem : t -> key -> bool Lwt.t

Check if a key exists.

val iter : t -> (key -> value Lwt.t -> unit Lwt.t) -> unit Lwt.t

iter t fn call the function fn on all t's keys and values.

val add : t -> value -> key Lwt.t

Write the contents of a value to the store. It's the responsibility of the append-only store to generate a consistent key.

module Path = C.Path

Step provides base functions on node steps.

module Key : Hash.S with type t = key

Key provides base functions for node keys.

module Val : S with type t = value and type node = key and type step = Path.step with type contents = C.key

Val provides base functions for node values.

OCaml

Innovation. Community. Security.