Struct sc_state_db::StateDb

pub struct StateDb<BlockHash: Hash, Key: Hash> { /* fields omitted */ }

State DB maintenance. See module description. Can be shared across threads.

Implementations

impl<BlockHash: Hash + MallocSizeOf, Key: Hash + MallocSizeOf> StateDb<BlockHash, Key>

pub fn new<D: MetaDb>(
    mode: PruningMode,
    ref_counting: bool,
    db: &D
) -> Result<StateDb<BlockHash, Key>, Error<D::Error>>

Creates a new instance. Does not expect any metadata in the database.

pub fn insert_block<E: Debug>(
    &self,
    hash: &BlockHash,
    number: u64,
    parent_hash: &BlockHash,
    changeset: ChangeSet<Key>
) -> Result<CommitSet<Key>, Error<E>>

Add a new non-canonical block.

pub fn canonicalize_block<E: Debug>(
    &self,
    hash: &BlockHash
) -> Result<CommitSet<Key>, Error<E>>

Finalize a previously inserted block.

pub fn pin(&self, hash: &BlockHash) -> Result<(), PinError>

Prevents pruning of specified block and its descendants.

pub fn unpin(&self, hash: &BlockHash)

Allows pruning of specified block.

pub fn get<D: NodeDb, Q: ?Sized>(
    &self,
    key: &Q,
    db: &D
) -> Result<Option<DBValue>, Error<D::Error>> where
    Q: AsRef<D::Key>,
    Key: Borrow<Q>,
    Q: Hash + Eq, 

Get a value from non-canonical/pruning overlay or the backing DB.

pub fn revert_one(&self) -> Option<CommitSet<Key>>

Revert all non-canonical blocks with the best block number. Returns a database commit or None if not possible. For archive an empty commit set is returned.

pub fn remove(&self, hash: &BlockHash) -> Option<CommitSet<Key>>

Remove specified non-canonical block. Returns a database commit or None if not possible.

pub fn best_canonical(&self) -> Option<u64>

Returns last finalized block number.

pub fn is_pruned(&self, hash: &BlockHash, number: u64) -> bool

Check if block is pruned away.

pub fn apply_pending(&self)

Apply all pending changes

pub fn revert_pending(&self)

Revert all pending changes

pub fn memory_info(&self) -> StateDbMemoryInfo

Returns the current memory statistics of this instance.