Struct sc_client_api::leaves::LeafSet

source · [−]

pub struct LeafSet<H, N> { /* private fields */ }

Expand description

list of leaf hashes ordered by number (descending). stored in memory for fast access. this allows very fast checking and modification of active leaves.

Implementations

impl<H, N> LeafSet<H, N> where
H: Clone + PartialEq + Decode + Encode,
N: Debug + Clone + AtLeast32Bit + Decode + Encode,

pub fn new() -> Self

Construct a new, blank leaf set.

pub fn read_from_db(
    db: &dyn Database<[u8 ; 32]>,
    column: u32,
    prefix: &[u8 ]
) -> Result<Self>

Read the leaf list from the DB, using given prefix for keys.

pub fn import(
    &mut self,
    hash: H,
    number: N,
    parent_hash: H
) -> Option<ImportDisplaced<H, N>>

update the leaf list on import. returns a displaced leaf if there was one.

pub fn finalize_height(&mut self, number: N) -> FinalizationDisplaced<H, N>

Note a block height finalized, displacing all leaves with number less than the finalized block’s.

Although it would be more technically correct to also prune out leaves at the same number as the finalized block, but with different hashes, the current behavior is simpler and our assumptions about how finalization works means that those leaves will be pruned soon afterwards anyway.

pub fn undo(&mut self) -> Undo<'_, H, N>

Undo all pending operations.

This returns an Undo struct, where any Displaced objects that have returned by previous method calls should be passed to via the appropriate methods. Otherwise, the on-disk state may get out of sync with in-memory state.

pub fn revert(&mut self, best_hash: H, best_number: N)

Revert to the given block height by dropping all leaves in the leaf set with a block number higher than the target.

pub fn hashes(&self) -> Vec<H>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

returns an iterator over all hashes in the leaf set ordered by their block number descending.

pub fn count(&self) -> usize

Number of known leaves

pub fn prepare_transaction(
    &mut self,
    tx: &mut Transaction<[u8 ; 32]>,
    column: u32,
    prefix: &[u8 ]
)

Write the leaf list to the database transaction.

Trait Implementations

impl<H: Clone, N: Clone> Clone for LeafSet<H, N>

fn clone(&self) -> LeafSet<H, N>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<H: Debug, N: Debug> Debug for LeafSet<H, N>

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

Formats the value using the given formatter. Read more

impl<H: PartialEq, N: PartialEq> PartialEq<LeafSet<H, N>> for LeafSet<H, N>

fn eq(&self, other: &LeafSet<H, N>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &LeafSet<H, N>) -> bool

This method tests for !=.

impl<H: Eq, N: Eq> Eq for LeafSet<H, N>

impl<H, N> StructuralEq for LeafSet<H, N>

impl<H, N> StructuralPartialEq for LeafSet<H, N>

Auto Trait Implementations

impl<H, N> RefUnwindSafe for LeafSet<H, N> where
H: RefUnwindSafe,
N: RefUnwindSafe,

impl<H, N> Send for LeafSet<H, N> where
H: Send,
N: Send,

impl<H, N> Sync for LeafSet<H, N> where
H: Sync,
N: Sync,

impl<H, N> Unpin for LeafSet<H, N> where
H: Unpin,
N: Unpin,

impl<H, N> UnwindSafe for LeafSet<H, N> where
H: UnwindSafe + RefUnwindSafe,
N: UnwindSafe + RefUnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

impl<T> CheckedConversion for T

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

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

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

impl<T> DynClone for T where
T: Clone,

pub fn __clone_box(&self, Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> 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.

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

Get a reference to the inner from the outer.

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

Get a mutable reference to the inner from the outer.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

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

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

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

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

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

pub fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of 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>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> MaybeDebug for T where
T: Debug,

impl<T> MaybeDebug for T where
T: Debug,

impl<T> MaybeRefUnwindSafe for T where
T: RefUnwindSafe,

impl<T> Member for T where
T: 'static + Send + Sync + Debug + Eq + PartialEq<T> + Clone,