package datakit

You can search for identifiers within the package.

in-package search v0.2.0

datakit
- Datakit
  - Blob
  - Dir
  - VFS
  - Vfs

Legend:
Library
Module
Module type
Parameter
Class
Class type

Private nod store.

include Irmin.AO with type key = Tree.Hash.t

Append-only stores

Append-only stores are read-only store where it is also possible to add values. Keys are derived from the values raw contents and hence are deterministic.

include Irmin.RO with type key = Tree.Hash.t

Read-only stores

type t

The type for read-only backend stores.

type key = Tree.Hash.t

The type for keys.

type value

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 -> 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 = Key

Path provides base functions on node paths.

val merge : t -> key option Irmin.Merge.t

merge is the 3-way merge function for nodes keys.

module Key : Irmin.Hash.S with type t = key

Key provides base functions for node keys.

module Metadata : Irmin.Metadata.S with type t = metadata

Metadata provides base functions for node metadata.

module Val : 
  Irmin.Private.Node.S
    with type t = value
     and type node = key
     and type metadata = Metadata.t
     and type step = Path.step
    with type contents = Contents.key

Val provides base functions for node values.

module Contents : Irmin.Contents.STORE with type key = Val.contents

Contents is the underlying contents store.