Enum CanonStateNotification 

pub enum CanonStateNotification<N = EthPrimitives>
where
    N: NodePrimitives,
{
    Commit {
        new: Arc<Chain<N>>,
    },
    Reorg {
        old: Arc<Chain<N>>,
        new: Arc<Chain<N>>,
    },
}

A notification that is sent when a new block is imported, or an old block is reverted.

The notification contains at least one Chain with the imported segment. If some blocks were reverted (e.g. during a reorg), the old chain is also returned.

Variants

Commit

The canonical chain was extended.

Fields

new: Arc<Chain<N>>

The newly added chain segment.

Reorg

A chain segment was reverted or reorged.

• In the case of a reorg, the reverted blocks are present in old, and the new blocks are present in new.
• In the case of a revert, the reverted blocks are present in old, and new is an empty chain segment.

Fields

old: Arc<Chain<N>>

The chain segment that was reverted.

new: Arc<Chain<N>>

The chain segment that was added on top of the canonical chain, minus the reverted blocks.

In the case of a revert, not a reorg, this chain segment is empty.

Implementations

impl<N> CanonStateNotification<N>

where N: NodePrimitives,

pub fn reverted(&self) -> Option<Arc<Chain<N>>>

Get the chain segment that was reverted, if any.

pub fn committed(&self) -> Arc<Chain<N>>

Get the newly imported chain segment, if any.

pub fn tip(&self) -> &RecoveredBlock<<N as NodePrimitives>::Block>

Gets the new tip of the chain.

Returns the new tip for Self::Reorg and Self::Commit variants which commit at least 1 new block.

Panics

If chain doesn’t have any blocks.

pub fn tip_checked( &self, ) -> Option<&RecoveredBlock<<N as NodePrimitives>::Block>>

Gets the new tip of the chain.

If the chain has no blocks, it returns None. Otherwise, it returns the new tip for Self::Reorg and Self::Commit variants.

pub fn block_receipts( &self, ) -> Vec<(BlockReceipts<<N as NodePrimitives>::Receipt>, bool)>

where <N as NodePrimitives>::SignedTx: Encodable2718,

Get receipts in the reverted and newly imported chain segments with their corresponding block numbers and transaction hashes.

The boolean in the tuple (2nd element) denotes whether the receipt was from the reverted chain segment.

Trait Implementations

impl<N> Clone for CanonStateNotification<N>

where N: Clone + NodePrimitives,

fn clone(&self) -> CanonStateNotification<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for CanonStateNotification<N>

where N: Debug + NodePrimitives,

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

Formats the value using the given formatter.

impl<'de, N> Deserialize<'de> for CanonStateNotification<N>

where N: NodePrimitives,

fn deserialize<__D>( __deserializer: __D, ) -> Result<CanonStateNotification<N>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N> PartialEq for CanonStateNotification<N>

where N: PartialEq + NodePrimitives,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> Serialize for CanonStateNotification<N>

where N: NodePrimitives,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<N> Eq for CanonStateNotification<N>

where N: Eq + NodePrimitives,

impl<N> StructuralPartialEq for CanonStateNotification<N>

where N: NodePrimitives,

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes

Size for each variant:

• Commit: 16 bytes
• Reorg: 16 bytes