package octez-internal-libs

  1. Overview
  2. Docs
A package that contains some libraries used by the Octez suite

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (1)

Authors

  1. T
    Tezos devteam
  2. T
    Thomas Gazagnaire
  3. T
    Thomas Leonard
  4. C
    Craig Ferguson

Maintainers

  1. C
    contact@tezos.com

Sources

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

doc/octez-internal-libs.irmin/Irmin/Storage/Read_only/index.html

Module Storage.Read_onlySource

Parameters

module M : Make
module Key : Type.S
module Value : Type.S

Signature

Read-only stores

Read-only stores are store where it is only possible to read existing values.

Sourcetype -'a t

The type for stores. The 'a phantom type carries information about the store mutability.

Sourcetype key = Key.t

The type for keys.

Sourcetype value = Value.t

The type for raw values.

Sourceval mem : [> Perms.read ] t -> key -> bool Lwt.t

mem t k is true iff k is present in t.

Sourceval find : [> Perms.read ] t -> key -> value option Lwt.t

find t k is Some v if k is associated to v in t and None is k is not present in t.

Sourceval close : 'a t -> unit Lwt.t

close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.

Sourceval v : Irmin__.Conf.t -> Perms.read t Lwt.t

v config is a function returning fresh store handles, with the configuration config, which is provided by the backend.