package octez-l2-libs

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

An index store mapping keys to values. It uses an index file internally.

type +'a t

The type of store built on indexes.

type key

The type of keys for the store.

type value

The type of values stored in the index,

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

Load (or initializes) a store in the file path. If readonly is true, the store will only be accessed in read only mode.

val mem : [> `Read ] t -> key -> bool Tezos_base.TzPervasives.tzresult Lwt.t

Returns true if the key has a value associated in the store.

val find : [> `Read ] t -> key -> value option Tezos_base.TzPervasives.tzresult Lwt.t

Returns the value associated to a key in the store, or None otherwise.

val add : ?flush:bool -> [> `Write ] t -> key -> value -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Add an association from a key to a value in the store. If flush (default to true) is set, the index is written on disk right away.

Closes the store. After this call the store cannot be accessed anymore (unless one calls load again).

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

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

gc ?async t iter garbage collects data stored in the index t by keeping only the ones that are reachable by iter. This call runs the GC asynchronously unless async is false. If a GC is already ongoing this new request is ignored and this call is a no-op.

val wait_gc_completion : 'a t -> unit Lwt.t

wait_gc_completion t returns a blocking thread if a GC run is ongoing.

val is_gc_finished : 'a t -> bool

is_gc_finished t returns true if there is no GC running.

OCaml

Innovation. Community. Security.