Struct sp_runtime::generic::Header

pub struct Header<Number: Copy + Into<U256> + TryFrom<U256>, Hash: HashT> {
    pub parent_hash: Hash::Output,
    pub number: Number,
    pub state_root: Hash::Output,
    pub extrinsics_root: Hash::Output,
    pub digest: Digest,
}

Abstraction over a block header for a substrate chain.

Fields

parent_hash: Hash::Output

The parent hash.

number: Number

The block number.

state_root: Hash::Output

The state trie merkle root

extrinsics_root: Hash::Output

The merkle root of the extrinsics.

digest: Digest

A chain-specific digest of data useful for light clients or referencing auxiliary data.

Implementations

impl<Number, Hash> Header<Number, Hash>where
    Number: Member + Hash + Copy + MaybeDisplay + AtLeast32BitUnsigned + Codec + Into<U256> + TryFrom<U256>,
    Hash: HashT,
    Hash::Output: Default + Hash + Copy + Member + MaybeDisplay + SimpleBitOps + Codec,

pub fn hash(&self) -> Hash::Output

Convenience helper for computing the hash of the header without having to import the trait.

impl Header<u64, BlakeTwo256>

pub fn new_from_number(number: <Self as Header>::Number) -> Self

A new header with the given number and default hash for all other fields.

Trait Implementations

impl<Number: Clone + Copy + Into<U256> + TryFrom<U256>, Hash: Clone + HashT> Clone for Header<Number, Hash>where
    Hash::Output: Clone,

fn clone(&self) -> Header<Number, Hash>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Number, Hash> Debug for Header<Number, Hash>where
    Number: Debug + Copy + Into<U256> + TryFrom<U256>,
    Hash: Debug + HashT,

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

Formats the value using the given formatter.

impl<Number, Hash: HashT> Decode for Header<Number, Hash>where
    Hash::Output: Decode,
    Number: HasCompact + Copy + Into<U256> + TryFrom<U256>,

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

Attempt to deserialise the value from input.

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<'de, Number: Copy + Into<U256> + TryFrom<U256>, Hash: HashT> Deserialize<'de> for Header<Number, Hash>where
    Hash::Output: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Number, Hash: HashT> Encode for Header<Number, Hash>where
    Hash::Output: Encode,
    Number: HasCompact + Copy + Into<U256> + TryFrom<U256>,

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

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    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<Number, Hash> Header for Header<Number, Hash>where
    Number: Member + MaybeSerializeDeserialize + Debug + Hash + MaybeDisplay + AtLeast32BitUnsigned + Codec + Copy + Into<U256> + TryFrom<U256> + FromStr,
    Hash: HashT,
    Hash::Output: Default + Hash + Copy + Member + Ord + MaybeSerialize + Debug + MaybeDisplay + SimpleBitOps + Codec,

type Number = Number

Header number.

type Hash = <Hash as Hash>::Output

Header hash type

type Hashing = Hash

Hashing algorithm

fn number(&self) -> &Self::Number

Returns a reference to the header number.

fn set_number(&mut self, num: Self::Number)

Sets the header number.

fn extrinsics_root(&self) -> &Self::Hash

Returns a reference to the extrinsics root.

fn set_extrinsics_root(&mut self, root: Self::Hash)

Sets the extrinsic root.

fn state_root(&self) -> &Self::Hash

Returns a reference to the state root.

fn set_state_root(&mut self, root: Self::Hash)

Sets the state root.

fn parent_hash(&self) -> &Self::Hash

Returns a reference to the parent hash.

fn set_parent_hash(&mut self, hash: Self::Hash)

Sets the parent hash.

fn digest(&self) -> &Digest

Returns a reference to the digest.

fn digest_mut(&mut self) -> &mut Digest

Get a mutable reference to the digest.

fn new(
    number: Self::Number,
    extrinsics_root: Self::Hash,
    state_root: Self::Hash,
    parent_hash: Self::Hash,
    digest: Digest
) -> Self

Creates new header.

fn hash(&self) -> Self::Hash

Returns the hash of the header.

impl<Number: PartialEq + Copy + Into<U256> + TryFrom<U256>, Hash: PartialEq + HashT> PartialEq<Header<Number, Hash>> for Header<Number, Hash>where
    Hash::Output: PartialEq,

fn eq(&self, other: &Header<Number, Hash>) -> bool

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

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

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

impl<Number: Copy + Into<U256> + TryFrom<U256>, Hash: HashT> Serialize for Header<Number, Hash>where
    Hash::Output: Serialize,

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

Serialize this value into the given Serde serializer.

impl<Number, Hash> TypeInfo for Header<Number, Hash>where
    Hash::Output: TypeInfo + 'static,
    Number: HasCompact + Copy + Into<U256> + TryFrom<U256> + TypeInfo + 'static,
    Hash: HashT + TypeInfo + 'static,

type Identity = Header<Number, Hash>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Number, Hash: HashT> EncodeLike<Header<Number, Hash>> for Header<Number, Hash>where
    Hash::Output: Encode,
    Number: HasCompact + Copy + Into<U256> + TryFrom<U256>,

impl<Number: Eq + Copy + Into<U256> + TryFrom<U256>, Hash: Eq + HashT> Eq for Header<Number, Hash>where
    Hash::Output: Eq,

impl<Number: Copy + Into<U256> + TryFrom<U256>, Hash: HashT> StructuralEq for Header<Number, Hash>

impl<Number: Copy + Into<U256> + TryFrom<U256>, Hash: HashT> StructuralPartialEq for Header<Number, Hash>