package octez-l2-libs

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

Module Indexed_store.Make_singletonSource

Parameters

Signature

Sourcetype +'a t

The type of the singleton store.

Sourceval load : path:string -> 'a Store_sigs.mode -> 'a t Tezos_base.TzPervasives.tzresult Lwt.t

Load (or initializes) a singleton store in the file path.

Sourceval read : [> `Read ] t -> S.t option Tezos_base.TzPervasives.tzresult Lwt.t

Reads the current value from the disk. Returns None if the file does not exist.

Sourceval write : [> `Write ] t -> S.t -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Write the value to disk.

Sourceval delete : [> `Write ] t -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Deletes the value from the disk.

Sourceval readonly : [> `Read ] t -> [ `Read ] t

readonly t returns a read only version of the store t.