Enum CumulusDigestItem 

pub enum CumulusDigestItem {
    RelayParent(Hash),
    CoreInfo(CoreInfo),
    BlockBundleInfo(BlockBundleInfo),
    UseFullCore,
}

Consensus header digests for Cumulus parachains.

Variants

RelayParent(Hash)

A digest item indicating the relay-parent a parachain block was built against.

CoreInfo(CoreInfo)

A digest item providing information about the core selected on the relay chain for this block.

BlockBundleInfo(BlockBundleInfo)

A digest item providing information about the position of the block in the bundle.

UseFullCore

A digest item informing the node that this block should be put alone onto a core.

In other words, the core should not be shared with other blocks.

Under certain conditions (mainly runtime misconfigurations) the digest is still set when there are muliple blocks per core. This is done to communicate to the collator that block production for this core should be stopped.

Implementations

impl CumulusDigestItem

pub fn to_digest_item(&self) -> DigestItem

Encode this as a Substrate DigestItem.

pub fn find_core_info(digest: &Digest) -> Option<CoreInfo>

Find CumulusDigestItem::CoreInfo in the given digest.

If there are multiple valid digests, this returns the value of the first one.

pub fn core_info_exists_at_max_once(digest: &Digest) -> CoreInfoExistsAtMaxOnce

Returns the found CoreInfo and iff Self::CoreInfo exists at max once in the given digest.

pub fn find_relay_block_identifier( digest: &Digest, ) -> Option<RelayBlockIdentifier>

Returns the RelayBlockIdentifier from the given digest.

The identifier corresponds to the relay parent used to build the parachain block.

pub fn find_block_bundle_info(digest: &Digest) -> Option<BlockBundleInfo>

Returns the BlockBundleInfo from the given digest.

pub fn contains_use_full_core(digest: &Digest) -> bool

Returns true if the given digest contains the Self::UseFullCore item.

pub fn is_last_block_in_core(digest: &Digest) -> Option<bool>

Returns true if the given digest is from a block that is the last block in a core.

Checks the following conditions:

• Is BlockBundleInfo::is_last set to true?
• Or is Self::UseFullCore digest present?
• Or is DigestItem::RuntimeEnvironmentUpdated digest present?

If any of these conditions is true, this function will return true.

Returns None if the BlockBundleInfo digest is not present, which is interpreted as the associated block is not using block bundling.

Trait Implementations

impl Clone for CumulusDigestItem

fn clone(&self) -> CumulusDigestItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CumulusDigestItem

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

Formats the value using the given formatter.

impl Decode for CumulusDigestItem

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for CumulusDigestItem

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl PartialEq for CumulusDigestItem

fn eq(&self, other: &CumulusDigestItem) -> 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 EncodeLike for CumulusDigestItem

impl StructuralPartialEq for CumulusDigestItem