package octez-l2-libs

  1. Overview
  2. Docs
Octez layer2 libraries

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-l2-libs.layer2_store/Tezos_layer2_store/Store_sigs/index.html

Module Tezos_layer2_store.Store_sigsSource

Sourcetype path = string list

The type of a path. paths are strings. They are used to determine the location where the data should be persisted on disk.

Sourcetype key_path_representation = string

Keys in Map-like storage functors are represented as strings.

Sourcetype rw = [
  1. | `Read
  2. | `Write
]
Sourcetype ro = [
  1. | `Read
]
Sourcetype _ mode =
  1. | Read_only : ro mode
  2. | Read_write : rw mode
Sourcemodule type BACKEND = sig ... end

BACKEND is the module type defining the backend for persisting data to disk. It is used by the functors in Store_utils to create Storage modules that persist data structures on disk.

Sourcemodule type Mutable_value = sig ... end

Module type respresenting a Mutable_value that is persisted on store.

Sourcemodule type STORAGE_INFO = sig ... end

This module contains information about where to store and retrieve contents of storage persisted on disk.

Sourcemodule type KEY = sig ... end

KEY is a module type used to construct Map-like storage modules. It defines how keys are used to determine a path on disk.

Sourcemodule type VALUE = sig ... end

VALUE is a module type to define values that will be persisted on disk via storage modules.

Sourcemodule type Map = sig ... end

Generic module type for maps to be persisted on disk.

Sourcemodule type Append_only_map = sig ... end

Generic module type for append-only maps to be persisted on disk.

Sourcemodule type Nested_map = sig ... end

Nested_map is a map where values are indexed by both a primary and secondary key. It allows more flexibility over a map whose keys are tupls of the form `(primary_key, secondary_key)`. In particular, it provides functions to retrieve all the bindings in a map that share the same primary_key.

Sourcemodule type COMPARABLE_KEY = sig ... end

COMPARABLE_KEY is a module type used to define secondary keys in nested maps.

Sourcemodule type Store = sig ... end
OCaml

Innovation. Community. Security.