package octez-smart-rollup-node-lib

  1. Overview
  2. Docs
package octez-smart-rollup-node-lib
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Store_v2.InboxesSource

Storage for persisting inboxes.

include Tezos_layer2_store.Indexed_store.INDEXED_FILE with type key := Octez_smart_rollup.Inbox.Hash.t with type value := Octez_smart_rollup.Inbox.t with type header := unit
Sourcetype +'a t

The type of indexed file store.

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

Sourceval header : [> `Read ] t -> Octez_smart_rollup.Inbox.Hash.t -> unit option Tezos_base.TzPervasives.tzresult Lwt.t

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

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

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

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

Sourceval 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.

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

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

gc ?async t filter garbage collects data stored in the store t by keeping only elements that satisfy the predicate filter. 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.

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

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

Sourceval is_gc_finished : 'a t -> bool

is_gc_finished t returns true if there is no GC running.

Sourceval append : ?flush:bool -> [> `Write ] t -> key:Octez_smart_rollup.Inbox.Hash.t -> value:Octez_smart_rollup.Inbox.t -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Append a new binding to the indexed file store.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct