package tezos-protocol-016-PtMumbai
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=ad9e08819871c75ba6f4530b125f7d157799398e4d77a1e6bfea9d91ff37ff55
sha512=c5dc4d40cc09bc6980fbbdb5c2e105bf4252cf9cfcb2b49660b0ebe4dc789f6709ec3b3bf2f87d81580d3eed9521eeb1c960f24d9b14eb0285aaba1f84d10a9b
doc/tezos-protocol-016-PtMumbai.raw/Tezos_raw_protocol_016_PtMumbai/Raw_context/Local_context/index.html
Module Raw_context.Local_contextSource
Local_context provides functions for local access from a specific directory.
include Raw_context_intf.VIEW
with type t = local_context
and type tree := tree
and type key := key
and type value := value
The type for context views.
Getters
mem t k is an Lwt promise that resolves to true iff k is bound to a value in t.
mem_tree t k is like mem but for trees.
val get :
t ->
key ->
value Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tget t k is an Lwt promise that resolves to Ok v if k is bound to the value v in t and Storage_ErrorMissing_key otherwise.
val get_tree :
t ->
key ->
tree Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tget_tree is like get but for trees.
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.
find_tree t k is like find but for trees.
val list :
t ->
?offset:int ->
?length:int ->
key ->
(string * tree) list Tezos_protocol_environment_016_PtMumbai.Lwt.tlist 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
val init :
t ->
key ->
value ->
t Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tinit t k v is an Lwt promise that resolves to Ok c if:
kis unbound int;kis bound tovinc;- and
cis similar tototherwise.
It is Storage_errorExisting_key if k is already bound in t.
val init_tree :
t ->
key ->
tree ->
t Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tinit_tree is like init but for trees.
val update :
t ->
key ->
value ->
t Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tupdate t k v is an Lwt promise that resolves to Ok c if:
kis bound int;kis bound tovinc;- and
cis similar tototherwise.
It is Storage_errorMissing_key if k is not already bound in t.
val update_tree :
t ->
key ->
tree ->
t Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tupdate_tree is like update but for trees.
add t k v is an Lwt promise that resolves to c such that:
kis bound tovinc;- and
cis similar tototherwise.
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.
add_tree is like add but for trees.
remove t k v is an Lwt promise that resolves to c such that:
kis unbound inc;- and
cis similar tototherwise.
val remove_existing :
t ->
key ->
t Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tremove_existing t k v is an Lwt promise that resolves to Ok c if:
kis bound intto a value;kis unbound inc;- and
cis similar tototherwise.
val remove_existing_tree :
t ->
key ->
t Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresult
Tezos_protocol_environment_016_PtMumbai.Lwt.tremove_existing_tree t k v is an Lwt promise that reolves to Ok c if:
kis bound intto a tree;kis unbound inc;- and
cis similar tototherwise.
val add_or_remove :
t ->
key ->
value option ->
t Tezos_protocol_environment_016_PtMumbai.Lwt.tadd_or_remove t k v is:
add t k xifvisSome x;remove t kotherwise.
val add_or_remove_tree :
t ->
key ->
tree option ->
t Tezos_protocol_environment_016_PtMumbai.Lwt.tadd_or_remove_tree t k v is:
add_tree t k xifvisSome x;remove t kotherwise.
Folds
val fold :
?depth:Raw_context_intf.depth ->
t ->
key ->
order:[ `Sorted | `Undefined ] ->
init:'a ->
f:(key -> tree -> 'a -> 'a Tezos_protocol_environment_016_PtMumbai.Lwt.t) ->
'a Tezos_protocol_environment_016_PtMumbai.Lwt.tfold ?depth t root ~order ~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.
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 dfolds over nodes and values of depth exactlyd.Lt dfolds over nodes and values of depth strictly less thand.Le dfolds over nodes and values of depth less than or equal tod.Gt dfolds over nodes and values of depth strictly more thand.Ge dfolds over nodes and values of depth more than or equal tod.
If order is `Sorted (the default), the elements are traversed in lexicographic order of their keys. For large nodes, it is memory-consuming, use `Undefined for a more memory efficient fold.
Hash configurations
config t is t's hash configuration.
length t key is an Lwt promise that resolves to the number of files and sub-nodes stored under k in t.
It is equivalent to list t k >|= List.length but has a constant-time complexity.
Most of the time, this function does not perform any I/O as the length is cached in the tree. It may perform one read to load the root node of the tree in case it has not been loaded already. The initial constant is the same between list and length. They both perform the same kind of I/O reads. While list usually performs a linear number of reads, length does at most one.
val consume_gas :
local_context ->
Gas_limit_repr.cost ->
local_context Tezos_protocol_environment_016_PtMumbai.Error_monad.tzresultInternally used in Storage_functors to consume gas from within a view. May raise Block_quota_exceeded or Operation_quota_exceeded.
Internally used in Storage_functors to retrieve the full key of a partial key relative to the local_context.