package tezos-context

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Content-addressable stores

tezos-context
- Tezos_context
  - Context
    
    Checks
    
    Pack
    
    Integrity_check
    
    Integrity_check_index
    
    Integrity_check_inodes
    
    Reconstruct_index
    
    Stat
    
    S
    
    Tree
    
    Tree
  - Context_dump
    
    Dump_interface
    
    Block_header
    
    Commit_hash
    
    Kinded_hash
    
    Make
    
    I
    
    Block_header
    
    Commit_hash
    
    Kinded_hash
    
    S
  - Internal_for_tests
    
    Utils
    
    Arena
    
    Small_list
    
    String_set
tezos-context.encoding
- Tezos_context_encoding
  - Context
    
    Branch
    
    Commit
    
    Conf
    
    Contents
    
    Hash
    
    Metadata
    
    Node
    
    H
    
    M
    
    P
    
    Path
tezos-context.helpers
- Tezos_context_helpers
  - Context
    
    DB
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    Key
    
    Metadata
    
    Private
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Repo
    
    Status
    
    Tree
    
    Contents
    
    Proof
    
    Make_tree
    
    DB
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    Key
    
    Metadata
    
    Private
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Key
    
    Val
    
    Key
    
    Metadata
    
    Val
    
    Repo
    
    Slice
    
    Sync
    
    Repo
    
    Status
    
    Tree
    
    Contents
    
    Proof
tezos-context.memory
- Tezos_context_memory
  - Context
    
    Tree
tezos-context.sigs
- Tezos_context_sigs
  - Context
    
    HASH_VERSION
    
    Kind
    
    S
    
    Tree
    
    TREE
    
    VIEW

Legend:
Library
Module
Module type
Parameter
Class
Class type

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.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 add : [> Irmin.Perms.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.Perms.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.Perms.read_write ] t -> key option Irmin.Merge.t

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

module Key : Irmin.Hash.TYPED with type t = key and type value = value

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 : Irmin.Contents.STORE with type key = Val.hash

Contents is the underlying contents store.