package tezos-context

  1. Overview
  2. Docs
Tezos: on-disk context abstraction for `octez-node`

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-17.3.tar.gz
sha256=7062cd57addd452852598a2214ade393130efa087b99068d53713bdf912b3680
sha512=08e4091144a03ce3c107fb91a66501bd8b65ca3278917c455a2eaac6df3e108ade63f6ab8340a4bb152d60f404326e464d0ec95d26cafe8e82f870465d24a5fc

doc/tezos-context.dump/Tezos_context_dump/Context_dump/Make/argument-1-I/index.html

Parameter Make.I

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
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
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.