package tezos-protocol-013-PtJakart

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

The type for context views.

type key = string list

The type for context keys.

type value = bytes

The type for context values.

type tree

The type for context trees.

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.

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.

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

init t k v is an Lwt promise that resolves to Ok c if:

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

It is Storage_errorExisting_key if k is already bound in t.

update t k v is an Lwt promise that resolves to Ok c if:

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

It is Storage_errorMissing_key if k is not already bound in 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.

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 in c;
  • and c is similar to t otherwise.

remove_existing t k v is an Lwt promise that resolves to Ok c if:

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

remove_existing_tree t k v is an Lwt promise that reolves to Ok c if:

  • k is bound in t to a tree;
  • k is unbound in c;
  • and c is similar to t otherwise.
val add_or_remove : t -> key -> value option -> t Tezos_protocol_environment_013_PtJakart.Lwt.t

add_or_remove t k v is:

  • add t k x if v is Some x;
  • remove t k otherwise.
val add_or_remove_tree : t -> key -> tree option -> t Tezos_protocol_environment_013_PtJakart.Lwt.t

add_or_remove_tree t k v is:

  • add_tree t k x if v is Some x;
  • remove t k otherwise.

Folds

val fold : ?depth:depth -> t -> key -> order:[ `Sorted | `Undefined ] -> init:'a -> f:(key -> tree -> 'a -> 'a Tezos_protocol_environment_013_PtJakart.Lwt.t) -> 'a Tezos_protocol_environment_013_PtJakart.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 exactly d.
  • Lt d folds over nodes and values of depth strictly less than d.
  • Le d folds over nodes and values of depth less than or equal to d.
  • Gt d folds over nodes and values of depth strictly more than d.
  • Ge d folds over nodes and values 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, it is memory-consuming, use `Undefined for a more memory efficient fold.

Hash configurations

val config : t -> config

config t is t's hash configuration.