package irmin

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

LINK_MAKER is the signature exposed by store which enable adding relation between keys. This is used to decouple the way keys are manipulated by the Irmin runtime and the keys used for storage. This is useful when trying to optimize storage for random-access file operations or for encryption.

Parameters

module K : Hash.S

Signature

include LINK with type key = K.t and type value = K.t

The link store contains verified links between low-level keys. This is used to certify that a value can be accessed via different keys: because they have been obtained using different hash functions (SHA1 and SHA256 for instance) or because the value might have different but equivalent concrete representation (for instance a set might be represented as various equivalent trees).

include RO with type key = K.t with type value = K.t

Read-only stores

type t

The type for read-only backend stores.

type key = K.t

The type for keys.

type value = K.t

The type for raw values.

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

mem t k is true iff k is present in t.

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

find t k is Some v if k is associated to v in t and None is k is not present in t.

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

add t src dst add a link between the key src and the value dst.

val v : config -> t Lwt.t