Struct sc_client_api::client::BlockImportNotification

pub struct BlockImportNotification<Block: BlockT> {
    pub hash: Block::Hash,
    pub origin: BlockOrigin,
    pub header: Block::Header,
    pub is_new_best: bool,
    pub tree_route: Option<Arc<TreeRoute<Block>>>,
    /* private fields */
}

Summary of an imported block

Fields

hash: Block::Hash

Imported block header hash.

origin: BlockOrigin

Imported block origin.

header: Block::Header

Imported block header.

is_new_best: bool

Is this the new best block.

tree_route: Option<Arc<TreeRoute<Block>>>

Tree route from old best to new best parent.

If None, there was no re-org while importing.

Implementations

impl<Block: BlockT> BlockImportNotification<Block>

pub fn new(
    hash: Block::Hash,
    origin: BlockOrigin,
    header: Block::Header,
    is_new_best: bool,
    tree_route: Option<Arc<TreeRoute<Block>>>,
    unpin_worker_sender: TracingUnboundedSender<Block::Hash>
) -> Self

Create new notification

pub fn into_unpin_handle(self) -> UnpinHandle<Block>

Consume this notification and extract the unpin handle.

Note: Only use this if you want to keep the block pinned in the backend.

impl<Block: BlockT> BlockImportNotification<Block>

pub fn from_summary(
    summary: ImportSummary<Block>,
    unpin_worker_sender: TracingUnboundedSender<Block::Hash>
) -> BlockImportNotification<Block>

Create finality notification from finality summary.

Trait Implementations

impl<Block: Clone + BlockT> Clone for BlockImportNotification<Block>where
    Block::Hash: Clone,
    Block::Header: Clone,

fn clone(&self) -> BlockImportNotification<Block>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Block: Debug + BlockT> Debug for BlockImportNotification<Block>where
    Block::Hash: Debug,
    Block::Header: Debug,

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

Formats the value using the given formatter.

impl<B: BlockT> TryFrom<BlockImportNotification<B>> for ChainEvent<B>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(n: BlockImportNotification<B>) -> Result<Self, ()>

Performs the conversion.