package irmin-containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Commit Store

irmin-containers
- Irmin_containers
  - Blob_log
    
    FS
    
    Make
    
    T
    
    Mem
    
    S
  - Content_addressable
  - Counter
    
    FS
    
    Make
    
    Mem
    
    S
  - Linked_log
    
    FS
    
    C
    
    Make
    
    C
    
    T
    
    Mem
    
    C
    
    S
  - Lww_register
    
    FS
    
    Make
    
    T
    
    Mem
    
    S
  - Time
    
    Machine
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

Commit Store

include Irmin.Indexable.S with type hash = Hash.t with type key = commit_key

Read-only stores

Read-only stores are store where it is only possible to read existing values.

type -'a t

The type for stores. The 'a phantom type carries information about the store mutability.

type key = commit_key

The type for keys.

type value

The type for raw values.

val mem : [> Irmin.Perms.read ] t -> key -> bool Lwt.t

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

val find : [> Irmin.Perms.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 close : 'a t -> unit Lwt.t

close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.

type hash = Hash.t

The type of hashes of value.

val add : [> Irmin.Perms.write ] t -> value -> key Lwt.t

Write the contents of a value to the store, and obtain its key.

val unsafe_add : [> Irmin.Perms.write ] t -> hash -> value -> key Lwt.t

Same as add but allows specifying the value's hash directly. The backend might choose to discard that hash and/or can be corrupt if the hash is not consistent.

val index : [> Irmin.Perms.read ] t -> hash -> key option Lwt.t

Indexing maps the hash of a value to a corresponding key of that value in the store. For stores that are addressed by hashes directly, this is typically fun _t h -> Lwt.return (Key.of_hash h); for stores with more complex addressing schemes, index may attempt a lookup operation in the store.

In general, indexing is best-effort and reveals no information about the membership of the value in the store. In particular:

index t hash = Some key doesn't guarantee mem t key: the value with hash hash may still be absent from the store;

index t hash = None doesn't guarantee that there is no key such that mem t key and Key.to_hash key = hash: the value may still be present in the store under a key that is not indexed.

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

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

val batch : 
  Irmin.Perms.read t ->
  ([ Irmin.Perms.read | Irmin.Perms.write ] t -> 'a Lwt.t) ->
  'a Lwt.t

batch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.

module Key : Irmin.Key.S with type t = key and type hash = hash

module Info = Schema.Info

Commit info.

module Val : sig ... end

Val provides functions for commit values.

module Hash : Irmin.Hash.Typed with type t = hash and type value = value

module Node : Irmin.Node.Store with type key = Val.node_key

Node is the underlying node store.

val merge : 
  [> Irmin.Perms.read_write ] t ->
  info:Info.f ->
  key option Irmin.Merge.t

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