Struct sc_state_db::StateDb

source · [−]

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

Expand description

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

Implementations

source

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

source

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.

source

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.

source

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

Finalize a previously inserted block.

source

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

Prevents pruning of specified block and its descendants.

source

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

Allows pruning of specified block.

source

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.

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 best_canonical(&self) -> Option<u64>

Returns last finalized block number.

source

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

Check if block is pruned away.

source

pub fn apply_pending(&self)

Apply all pending changes

source

pub fn revert_pending(&self)

Revert all pending changes

source

pub fn memory_info(&self) -> StateDbMemoryInfo

Returns the current memory statistics of this instance.

Auto Trait Implementations

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

impl<BlockHash, Key> Send for StateDb<BlockHash, Key>

impl<BlockHash, Key> Sync for StateDb<BlockHash, Key>

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

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

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub 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, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

source

pub fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source

pub fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

source

impl<T> Pointable for T

source

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

source

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

source

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

source

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

source

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> SaturatedConversion for T

source

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

source

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

source

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

source

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

source

pub fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct sc_state_db::StateDb

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

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

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

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

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

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,

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

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

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

pub fn apply_pending(&self)

pub fn revert_pending(&self)

pub fn memory_info(&self) -> StateDbMemoryInfo

Auto Trait Implementations

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

impl<BlockHash, Key> Send for StateDb<BlockHash, Key>

impl<BlockHash, Key> Sync for StateDb<BlockHash, Key>

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T, Outer> IsWrappedBy<Outer> for T where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

pub fn from_ref(outer: &Outer) -> &T

pub fn from_mut(outer: &mut Outer) -> &mut T

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self where Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where Self: UniqueSaturatedInto<T>,

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

type Error = Infallible

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

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

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

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

impl<S, T> UncheckedInto<T> for S where T: UncheckedFrom<S>,

pub fn unchecked_into(self) -> T

impl<T, S> UniqueSaturatedInto<T> for S where T: Bounded, S: TryInto<T>,

pub fn unique_saturated_into(self) -> T

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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,

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

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

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

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

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

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

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

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

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

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

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,