package octez-l2-libs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Package contains no libraries

Parameters

module _ : NAME

module K : Index.Key.S

module V : sig ... end

include INDEXED_FILE
  with type key := K.t
  with type value := V.t
  with type header := V.Header.t

type +'a t

The type of indexed file store.

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

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

val header : 
  [> `Read ] t ->
  K.t ->
  V.Header.t option Tezos_base.TzPervasives.tzresult Lwt.t

Returns the header for a key if it exists in the store.

val read : 
  [> `Read ] t ->
  K.t ->
  (V.t * V.Header.t) option Tezos_base.TzPervasives.tzresult Lwt.t

Read a full value and header from the indexed file store.

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

Loads a new or existing indexed file store in the directory path.

val close : _ t -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Close the index and the file. One must call load again to read or write data in the store.

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

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

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

Append a new binding to the indexed file store.