package octez-l2-libs

  1. Overview
  2. Docs
Octez layer2 libraries

Install

Dune Dependency

Authors

Maintainers

Sources

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

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.