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<Hash::Output>,
}

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<Hash::Output>

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::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,
    Hash::Output: Clone,
    Hash::Output: Clone,
    Hash::Output: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

pub fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

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

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

Deserialize this value from the given Serde deserializer.

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

pub fn encode_to<T: Output>(&self, dest: &mut T)

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

pub fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

pub 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.

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

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

impl<Number, Hash> Header for Header<Number, Hash> where
    Number: Member + MaybeSerializeDeserialize + Debug + Hash + MaybeDisplay + AtLeast32BitUnsigned + Codec + Copy + Into<U256> + TryFrom<U256> + FromStr + MaybeMallocSizeOf,
    Hash: HashT,
    Hash::Output: Default + Hash + Copy + Member + Ord + MaybeSerialize + Debug + MaybeDisplay + SimpleBitOps + Codec + MaybeMallocSizeOf, 

type Number = Number

Header number.

type Hash = <Hash as HashT>::Output

Header hash type

type Hashing = Hash

Hashing algorithm

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

Returns a reference to the header number.

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

Sets the header number.

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

Returns a reference to the extrinsics root.

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

Sets the extrinsic root.

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

Returns a reference to the state root.

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

Sets the state root.

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

Returns a reference to the parent hash.

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

Sets the parent hash.

pub fn digest(&self) -> &Digest<Self::Hash>

Returns a reference to the digest.

pub fn digest_mut(&mut self) -> &mut Digest<Self::Hash>

Get a mutable reference to the digest.

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

Creates new header.

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

Returns the hash of the header.

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

pub fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself. If T::size_of is a constant, consider implementing constant_size as well.

pub fn constant_size() -> Option<usize>

Used to optimize MallocSizeOf implementation for collections like Vec and HashMap to avoid iterating over them unnecessarily. The Self: Sized bound is for object safety.

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

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

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

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

This method tests for !=.

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

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

Serialize this value into the given Serde serializer.

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>