package irmin-pack

  1. Overview
  2. Docs
Irmin backend which stores values in a pack file

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (9)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-2.9.0.tbz
sha256=7af11e14d312b9ae340997f8c27907b9fc9a0d19539fb643e1820d5183a76750
sha512=d7b61c6fddab0a8b61efe867b9a0fdc14c01eb1adeda2f5018b8dfee306c8324c77dd648c7cb9860e62a26e224955f9331b49d19cb693ad5d773efc53263d9fd

doc/irmin-pack.layered/Irmin_pack_layered/Maker_ext/Private/Node/index.html

Module Private.Node

Private node store.

Content-addressable stores

Content-addressable stores are store where it is possible to read and add new values. Keys are derived from the values raw contents and hence are deterministic.

type -'a t

The type for content-addressable backend stores. The 'a phantom type carries information about the store mutability.

type key = Hash.t

The type for keys.

type value

The type for raw values.

val mem : [> Irmin__.Import.read ] t -> key -> bool Lwt.t

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

val find : [> Irmin__.Import.read ] 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 : [> Irmin__.Import.write ] t -> value -> key Lwt.t

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

val unsafe_add : [> Irmin__.Import.write ] t -> key -> value -> unit Lwt.t

Same as add but allows to specify the key directly. The backend might choose to discared that key and/or can be corrupt if the key scheme is not consistent.

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

Clear the store. This operation is expected to be slow.

module Path = Key

Path provides base functions on node paths.

val merge : [> Irmin__.Import.read_write ] t -> key option Irmin__.Merge.t

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

module Key : sig ... end

Key provides base functions for node keys.

module Metadata : sig ... end

Metadata provides base functions for node metadata.

module Val : sig ... end

Val provides base functions for node values.

module Contents : sig ... end

Contents is the underlying contents store.