package tezos-context

You can search for identifiers within the package.

in-package search v0.2.0

tezos-context
- Tezos_context
tezos-context.disk
- Tezos_context_disk
  - Context
    
    Checks
    
    Index
    
    Integrity_check
    
    Stat
    
    Pack
    
    Integrity_check
    
    Integrity_check_index
    
    Integrity_check_inodes
    
    Reconstruct_index
    
    Stat
    
    Stats_commit
    
    Proof
    
    Internal_for_tests
    
    Stream
    
    Tree
  - Context_binary
    
    Checks
    
    Index
    
    Integrity_check
    
    Stat
    
    Pack
    
    Integrity_check
    
    Integrity_check_index
    
    Integrity_check_inodes
    
    Reconstruct_index
    
    Stat
    
    Stats_commit
    
    Proof
    
    Internal_for_tests
    
    Stream
    
    Tree
tezos-context.dump
- Tezos_context_dump
  - Context_dump
    
    Make
    
    I
    
    Block_header
    
    Commit_hash
    
    Kinded_hash
    
    Snapshot
  - Context_dump_intf
    
    Context_dump
    
    Make
    
    I
    
    Block_header
    
    Commit_hash
    
    Kinded_hash
    
    Snapshot
    
    Dump_interface
    
    Block_header
    
    Commit_hash
    
    Kinded_hash
    
    Snapshot
    
    Kinded_hash
    
    S
tezos-context.encoding
- Tezos_context_encoding
  - Context
    
    Conf
    
    Hash
    
    Schema
    
    Branch
    
    Commit
    
    Commit_key
    
    Node_key
    
    Contents
    
    Hash
    
    Metadata
    
    Node
    
    Contents_key
    
    Metadata
    
    Node_key
    
    Path
  - Context_binary
    
    Conf
tezos-context.helpers
- Tezos_context_helpers
  - Context
    
    DB
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
    
    Make_config
    
    Conf
    
    Make_proof
    
    DB
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
    
    Proof
    
    Store_conf
    
    Make_tree
    
    Conf
    
    DB
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
  - Env
tezos-context.memory
- Tezos_context_memory
  - Context
    
    Proof
    
    Internal_for_tests
    
    Stream
    
    Tree
  - Context_binary
    
    Proof
    
    Internal_for_tests
    
    Stream
    
    Tree
  - Make
    
    Encoding
    
    Conf
    
    Hash
    
    Schema
    
    Branch
    
    Commit
    
    Commit_key
    
    Node_key
    
    Contents
    
    Hash
    
    Metadata
    
    Node
    
    Contents_key
    
    Metadata
    
    Node_key
    
    Path
    
    Proof
    
    Internal_for_tests
    
    Stream
    
    Tree
tezos-context.merkle_proof_encoding
- Tezos_context_merkle_proof_encoding
  - Merkle_proof_encoding
    
    V1
    
    Tree2
    
    Tree32
    
    V2
    
    Tree2
    
    Tree32
tezos-context.sigs
- Tezos_context_sigs
  - Config
  - Context
    
    HASH_VERSION
    
    Kind
    
    PROOF
    
    PROOF_ENCODING
    
    Proof_types
    
    Internal_for_tests
    
    Stream
    
    Storelike
    
    TEZOS_CONTEXT
    
    Proof
    
    Tree
    
    TREE
    
    VIEW
    
    With_get_data
    
    Store

Legend:
Library
Module
Module type
Parameter
Class
Class type

type index

type context

type tree

type hash

type contents := bytes

type step := string

type commit_info

type batch

val batch : index -> (batch -> 'a Lwt.t) -> 'a Lwt.t

val commit_info_encoding : commit_info Tezos_base.TzPervasives.Data_encoding.t

val hash_equal : hash -> hash -> bool

module Block_header : sig ... end

module Commit_hash : sig ... end

module Kinded_hash : Context_dump_intf.Kinded_hash with type hash := hash

val context_parents : context -> Commit_hash.t list

val context_info : context -> commit_info

val checkout : index -> Commit_hash.t -> context option Lwt.t

val set_context : 
  info:commit_info ->
  parents:Commit_hash.t list ->
  context ->
  Commit_hash.t ->
  bool Lwt.t

val context_tree : context -> tree

val make_context : index -> context

val update_context : context -> tree -> context

val add_bytes : batch -> bytes -> tree Lwt.t

val add_dir : 
  batch ->
  (step * Kinded_hash.t,
    Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace)
    Tezos_base.TzPervasives.Seq_es.t ->
  (tree option, Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace)
    Stdlib.result
    Lwt.t

module Snapshot : sig ... end

This type exposes the internal nodes used in irmin in order to use them during snapshot import and export.

val tree_iteri_unique : 
  ?on_disk:bool ->
  index ->
  (Snapshot.t -> unit Lwt.t) ->
  tree ->
  int Lwt.t

tree_iteri_unique ?on_disk index f tree traverses tree, applying f to all inodes and contents.

f is called in post-order, that is f is first called on the leaves, and the last call to f is on the root of the tree.

The traversal order is stable.

The traversal skips objects that are structurally equal to objects that were already traversed. In other words, tree_iteri_unique internally uses a hash set in order to guarantee that all the objects passed to f don't hash the same way.

If on_disk is true (by default its false), it uses an on_disk index.

Returns the total number of elements visited.

type import

val v_import : ?in_memory:bool -> index -> import

v_import ?in_memory index creates an importer instance. If in_memory is true, the import will be fully in memory. in_memory is set to false by default.

val save_inode : index -> import -> Snapshot.t -> tree option Lwt.t

save_inode index importer elt saves elt to the store.

val close_import : import -> index -> unit

close importer close the importer instance.