package octez-proto-libs

  1. Overview
  2. Docs
Octez protocol libraries

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-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V4/Make/Context/index.html

Module Make.ContextSource

View over the context store, restricted to types, access and functional manipulation of an existing context.

Sourcetype depth = [
  1. | `Eq of int
  2. | `Le of int
  3. | `Lt of int
  4. | `Ge of int
  5. | `Gt of int
]

The tree depth of a fold. See the fold function for more information.

Sourcemodule type VIEW = sig ... end
Sourcemodule Kind : sig ... end
Sourcemodule type TREE = sig ... end

Tree provides immutable, in-memory partial mirror of the context, with lazy reads and delayed writes.

include VIEW with type key = string list and type value = bytes with type t = Tezos_protocol_environment__.Environment_context.Context.t
Sourcetype t

The type for context views.

Sourcetype key = string list

The type for context keys.

Sourcetype value = bytes

The type for context values.

Sourcetype tree

The type for context trees.

Getters

Sourceval mem : t -> key -> bool Lwt.t

mem t k is an Lwt promise that resolves to true iff k is bound to a value in t.

Sourceval mem_tree : t -> key -> bool Lwt.t

mem_tree t k is like mem but for trees.

Sourceval find : t -> key -> value option Lwt.t

find t k is an Lwt promise that resolves to Some v if k is bound to the value v in t and None otherwise.

Sourceval find_tree : t -> key -> tree option Lwt.t

find_tree t k is like find but for trees.

Sourceval list : t -> ?offset:int -> ?length:int -> key -> (string * tree) list Lwt.t

list t key is the list of files and sub-nodes stored under k in t. The result order is not specified but is stable.

offset and length are used for pagination.

Setters

Sourceval add : t -> key -> value -> t Lwt.t

add t k v is an Lwt promise that resolves to c such that:

  • k is bound to v in c;
  • and c is similar to t otherwise.

If k was already bound in t to a value that is physically equal to v, the result of the function is a promise that resolves to t. Otherwise, the previous binding of k in t disappears.

Sourceval add_tree : t -> key -> tree -> t Lwt.t

add_tree is like add but for trees.

Sourceval remove : t -> key -> t Lwt.t

remove t k v is an Lwt promise that resolves to c such that:

  • k is unbound in c;
  • and c is similar to t otherwise.

Folding

Sourceval fold : ?depth:depth -> t -> key -> order:[ `Sorted | `Undefined ] -> init:'a -> f:(key -> tree -> 'a -> 'a Lwt.t) -> 'a Lwt.t

fold ?depth t root ~init ~f recursively folds over the trees and values of t. The f callbacks are called with a key relative to root. f is never called with an empty key for values; i.e., folding over a value is a no-op.

Elements are traversed in lexical order of keys.

The depth is 0-indexed. If depth is set (by default it is not), then f is only called when the conditions described by the parameter is true:

  • Eq d folds over nodes and contents of depth exactly d.
  • Lt d folds over nodes and contents of depth strictly less than d.
  • Le d folds over nodes and contents of depth less than or equal to d.
  • Gt d folds over nodes and contents of depth strictly more than d.
  • Ge d folds over nodes and contents of depth more than or equal to d.

If order is `Sorted (the default), the elements are traversed in lexicographic order of their keys. For large nodes, these two modes are memory-consuming, use `Undefined for a more memory efficient fold.

Sourcemodule Tree : TREE with type t := t and type key := key and type value := value and type tree := tree

Tree provides immutable, in-memory partial mirror of the context, with lazy reads and delayed writes.

Sourceval register_resolver : 'a Base58.encoding -> (t -> string -> 'a list Lwt.t) -> unit
Sourceval complete : t -> string -> string list Lwt.t
Sourceval get_hash_version : t -> Context_hash.Version.t

Get the hash version used for the context

Sourceval set_hash_version : t -> Context_hash.Version.t -> t Error_monad.shell_tzresult Lwt.t

Set the hash version used for the context. It may recalculate the hashes of the whole context, which can be a long process. Returns an Error if the hash version is unsupported.

Sourcetype cache_key
Sourcetype cache_value = ..
Sourcemodule type CACHE = sig ... end
Sourcemodule Cache : CACHE with type t := t and type size := int and type index := int and type identifier := string and type key = cache_key and type value = cache_value