Struct Storage 

pub struct Storage { /* private fields */ }

Store key info and results of the scan.

rocksdb allows concurrent writes through a shared reference, so clones of the scanner storage represent the same database instance. When the final clone is dropped, the database is closed.

Implementations

impl Storage

pub fn sapling_result_for_index( &self, index: &SaplingScannedDatabaseIndex, ) -> Option<SaplingScannedResult>

Returns the result for a specific database index (key, block height, transaction index). Returns None if the result is missing or an empty marker for a birthday or progress height.

pub fn sapling_results_for_key_and_height( &self, sapling_key: &SaplingScanningKey, height: Height, ) -> BTreeMap<TransactionIndex, Option<SaplingScannedResult>>

Returns the results for a specific key and block height.

pub fn sapling_results_for_key( &self, sapling_key: &SaplingScanningKey, ) -> BTreeMap<Height, Vec<SaplingScannedResult>>

Returns all the results for a specific key, indexed by height.

pub fn sapling_keys_and_last_scanned_heights( &self, ) -> HashMap<SaplingScanningKey, Height>

Returns all the keys and their last scanned heights.

pub fn insert_sapling_results( &mut self, sapling_key: &SaplingScanningKey, height: Height, sapling_results: BTreeMap<TransactionIndex, SaplingScannedResult>, )

Inserts a batch of scanned sapling result for a key and height. If a result already exists for that key, height, and index, it is replaced.

pub fn delete_sapling_keys(&mut self, keys: Vec<SaplingScanningKey>)

Delete the sapling keys and their results, if they exist,

impl Storage

pub fn network(&self) -> Network

Returns the configured network for this database.

pub fn path(&self) -> &Path

Returns the Path where the files used by this database are located.

pub fn database_format_version_in_code() -> Version

The database format version in the running scanner code.

pub fn check_for_panics(&mut self)

Check for panics in code running in spawned threads. If a thread exited with a panic, resume that panic.

This method should be called regularly, so that panics are detected as soon as possible.

pub fn is_empty(&self) -> bool

Returns true if the database is empty.

impl Storage

pub fn new(config: &Config, network: &Network, read_only: bool) -> Self

Opens and returns the on-disk scanner results storage for config and network. If there is no existing storage, creates a new storage on disk.

Birthdays and scanner progress are marked by inserting an empty result for that height.

Performance / Hangs

This method can block while creating or reading database files, so it must be inside spawn_blocking() in async code.

pub fn add_sapling_key( &mut self, sapling_key: &SaplingScanningKey, birthday: impl Into<Option<Height>>, )

Add a sapling key to the storage.

Performance / Hangs

This method can block while writing database files, so it must be inside spawn_blocking() in async code.

pub fn sapling_keys_last_heights(&self) -> HashMap<SaplingScanningKey, Height>

Returns all the keys and their last scanned heights.

Performance / Hangs

This method can block while reading database files, so it must be inside spawn_blocking() in async code.

pub fn add_sapling_results( &mut self, sapling_key: &SaplingScanningKey, height: Height, sapling_results: BTreeMap<TransactionIndex, SaplingScannedResult>, )

Add the sapling results for height to the storage. The results can be any map of TransactionIndex to SaplingScannedResult.

All the results for the same height must be written at the same time, to avoid partial writes during shutdown.

Also adds empty progress tracking entries every INSERT_CONTROL_INTERVAL blocks if needed.

Performance / Hangs

This method can block while writing database files, so it must be inside spawn_blocking() in async code.

pub fn sapling_results( &self, sapling_key: &SaplingScanningKey, ) -> BTreeMap<Height, Vec<SaplingScannedResult>>

Returns all the results for a sapling key, for every scanned block height.

Performance / Hangs

This method can block while reading database files, so it must be inside spawn_blocking() in async code.

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Storage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.