Struct sc_state_db::StateDb

source ·
pub struct StateDb<BlockHash: Hash, Key: Hash, D: MetaDb> { /* private fields */ }
Expand description

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

Implementations§

source§

impl<BlockHash: Hash, Key: Hash, D: MetaDb> StateDb<BlockHash, Key, D>

source

pub fn open( db: D, requested_mode: Option<PruningMode>, ref_counting: bool, should_init: bool ) -> Result<(CommitSet<Key>, StateDb<BlockHash, Key, D>), Error<D::Error>>

Create an instance of StateDb.

source

pub fn pruning_mode(&self) -> PruningMode

source

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

Add a new non-canonical block.

source

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

Finalize a previously inserted block.

source

pub fn pin<F>( &self, hash: &BlockHash, number: u64, hint: F ) -> Result<(), PinError>where F: Fn() -> bool,

Prevents pruning of specified block and its descendants. hint used for further checking if the given block exists

source

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

Allows pruning of specified block.

source

pub fn sync(&self)

Confirm that all changes made to commit sets are on disk. Allows for temporarily pinned blocks to be released.

source

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

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

source

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.

source

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

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

source

pub fn last_canonicalized(&self) -> LastCanonicalized

Returns last canonicalized block.

source

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

Check if block is pruned away.

source

pub fn reset(&self, db: D) -> Result<(), Error<D::Error>>

Reset in-memory changes to the last disk-backed state.

Auto Trait Implementations§

§

impl<BlockHash, Key, D> !RefUnwindSafe for StateDb<BlockHash, Key, D>

§

impl<BlockHash, Key, D> Send for StateDb<BlockHash, Key, D>where D: Send,

§

impl<BlockHash, Key, D> Sync for StateDb<BlockHash, Key, D>where D: Send + Sync,

§

impl<BlockHash, Key, D> Unpin for StateDb<BlockHash, Key, D>where BlockHash: Unpin, D: Unpin, Key: Unpin,

§

impl<BlockHash, Key, D> UnwindSafe for StateDb<BlockHash, Key, D>where BlockHash: UnwindSafe, D: UnwindSafe, Key: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.