package tezos-protocol-alpha
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7062cd57addd452852598a2214ade393130efa087b99068d53713bdf912b3680
sha512=08e4091144a03ce3c107fb91a66501bd8b65ca3278917c455a2eaac6df3e108ade63f6ab8340a4bb152d60f404326e464d0ec95d26cafe8e82f870465d24a5fc
doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Raw_context/Local_context/index.html
Module Raw_context.Local_context
Source
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_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
get 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_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
get_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_alpha.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
val init :
t ->
key ->
value ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
init t k v
is an Lwt promise that resolves to Ok c
if:
k
is unbound int
;k
is bound tov
inc
;- and
c
is similar tot
otherwise.
It is Storage_errorExisting_key
if k
is already bound in t
.
val init_tree :
t ->
key ->
tree ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
init_tree
is like init
but for trees.
val update :
t ->
key ->
value ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
update t k v
is an Lwt promise that resolves to Ok c
if:
k
is bound int
;k
is bound tov
inc
;- and
c
is similar tot
otherwise.
It is Storage_errorMissing_key
if k
is not already bound in t
.
val update_tree :
t ->
key ->
tree ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
update_tree
is like update
but for trees.
add t k v
is an Lwt promise that resolves to c
such that:
k
is bound tov
inc
;- and
c
is similar tot
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.
add_tree
is like add
but for trees.
remove t k v
is an Lwt promise that resolves to c
such that:
k
is unbound inc
;- and
c
is similar tot
otherwise.
val remove_existing :
t ->
key ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
remove_existing t k v
is an Lwt promise that resolves to Ok c
if:
k
is bound int
to a value;k
is unbound inc
;- and
c
is similar tot
otherwise.
val remove_existing_tree :
t ->
key ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
remove_existing_tree t k v
is an Lwt promise that reolves to Ok c
if:
k
is bound int
to a tree;k
is unbound inc
;- and
c
is similar tot
otherwise.
add_or_remove t k v
is:
add t k x
ifv
isSome x
;remove t k
otherwise.
add_or_remove_tree t k v
is:
add_tree t k x
ifv
isSome x
;remove t k
otherwise.
Folds
val fold :
?depth:Raw_context_intf.depth ->
t ->
key ->
order:[ `Sorted | `Undefined ] ->
init:'a ->
f:(key -> tree -> 'a -> 'a Tezos_protocol_environment_alpha.Lwt.t) ->
'a Tezos_protocol_environment_alpha.Lwt.t
fold ?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 d
folds over nodes and values of depth exactlyd
.Lt d
folds over nodes and values of depth strictly less thand
.Le d
folds over nodes and values of depth less than or equal tod
.Gt d
folds over nodes and values of depth strictly more thand
.Ge d
folds 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_alpha.Error_monad.tzresult
Internally 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
.