Struct cnidarium::TempStorage

pub struct TempStorage { /* private fields */ }

A Storage instance backed by a tempfile::TempDir for testing.

The TempDir handle is bundled into the TempStorage, so the temporary directory is cleaned up when the TempStorage instance is dropped.

Implementations

impl TempStorage

pub async fn new() -> Result<Self>

pub async fn new_with_prefixes(prefixes: Vec<String>) -> Result<Self>

Methods from Deref<Target = Storage>

pub fn latest_version(&self) -> Version

Returns the latest version (block height) of the tree recorded by the Storage.

If the tree is empty and has not been initialized, returns u64::MAX.

pub fn subscribe(&self) -> Receiver<Snapshot>

Returns a [watch::Receiver] that can be used to subscribe to new state versions.

pub fn subscribe_changes(&self) -> Receiver<(Version, Arc<Cache>)>

Returns a [watch::Receiver] that can be used to subscribe to state changes.

pub fn latest_snapshot(&self) -> Snapshot

Returns a new Snapshot on top of the latest version of the tree.

pub fn snapshot(&self, version: Version) -> Option<Snapshot>

Fetches the Snapshot corresponding to the supplied jmt::Version from the [SnapshotCache]. Returns None if no match was found.

pub async fn prepare_commit( &self, delta: StateDelta<Snapshot> ) -> Result<StagedWriteBatch>

Prepares a commit for the provided StateDelta, returning a StagedWriteBatch. The batch can be committed to the database using the Storage::commit_batch method.

pub async fn commit(&self, delta: StateDelta<Snapshot>) -> Result<RootHash>

Commits the provided StateDelta to persistent storage as the latest version of the chain state.

pub fn commit_batch(&self, batch: StagedWriteBatch) -> Result<RootHash>

Commits the supplied StagedWriteBatch to persistent storage.

Migrations

In the case of chain state migrations we need to commit the new state without incrementing the version. If perform_migration is true the snapshot will not be written to the snapshot cache, and no subscribers will be notified. Substore versions will not be updated.

pub async fn commit_in_place( &self, delta: StateDelta<Snapshot> ) -> Result<RootHash>

Available on crate feature migration only.

Commit the provided StateDelta to persistent storage without increasing the version of the chain state, and skips the snapshot cache update.

Trait Implementations

impl AsRef<Storage> for TempStorage

fn as_ref(&self) -> &Storage

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for TempStorage

type Target = Storage

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.