Struct common_types::header::Header

pub struct Header { /* private fields */ }

A block header.

Reflects the specific RLP fields of a block in the chain with additional room for the seal which is non-specific.

Doesn’t do all that much on its own.

Two versions of header exist. First one is before EIP1559. Second version is after EIP1559. EIP1559 version added field base_fee_per_gas.

Implementations

impl Header

pub fn new() -> Self

Create a new, default-valued, header.

pub fn parent_hash(&self) -> &H256

Get the parent_hash field of the header.

pub fn timestamp(&self) -> u64

Get the timestamp field of the header.

pub fn number(&self) -> BlockNumber

Get the number field of the header.

pub fn author(&self) -> &Address

Get the author field of the header.

pub fn extra_data(&self) -> &Bytes

Get the extra data field of the header.

pub fn state_root(&self) -> &H256

Get the state root field of the header.

pub fn receipts_root(&self) -> &H256

Get the receipts root field of the header.

pub fn log_bloom(&self) -> &Bloom

Get the log bloom field of the header.

pub fn transactions_root(&self) -> &H256

Get the transactions root field of the header.

pub fn uncles_hash(&self) -> &H256

Get the uncles hash field of the header.

pub fn gas_used(&self) -> &U256

Get the gas used field of the header.

pub fn gas_limit(&self) -> &U256

Get the gas limit field of the header.

pub fn difficulty(&self) -> &U256

Get the difficulty field of the header.

pub fn seal(&self) -> &[Bytes]

Get the seal field of the header.

pub fn base_fee(&self) -> Option<U256>

Get the base fee field of the header.

pub fn decode_seal<'a, T: FromIterator<&'a [u8]>>(
    &'a self
) -> Result<T, DecoderError>

Get the seal field with RLP-decoded values as bytes.

pub fn set_parent_hash(&mut self, a: H256)

Set the number field of the header.

pub fn set_uncles_hash(&mut self, a: H256)

Set the uncles hash field of the header.

pub fn set_state_root(&mut self, a: H256)

Set the state root field of the header.

pub fn set_transactions_root(&mut self, a: H256)

Set the transactions root field of the header.

pub fn set_receipts_root(&mut self, a: H256)

Set the receipts root field of the header.

pub fn set_log_bloom(&mut self, a: Bloom)

Set the log bloom field of the header.

pub fn set_timestamp(&mut self, a: u64)

Set the timestamp field of the header.

pub fn set_number(&mut self, a: BlockNumber)

Set the number field of the header.

pub fn set_author(&mut self, a: Address)

Set the author field of the header.

pub fn set_extra_data(&mut self, a: Bytes)

Set the extra data field of the header.

pub fn set_gas_used(&mut self, a: U256)

Set the gas used field of the header.

pub fn set_gas_limit(&mut self, a: U256)

Set the gas limit field of the header.

pub fn set_difficulty(&mut self, a: U256)

Set the difficulty field of the header.

pub fn set_seal(&mut self, a: Vec<Bytes>)

Set the seal field of the header.

pub fn compute_hash(&mut self) -> H256

Get & memoize the hash of this header (keccak of the RLP with seal).

pub fn set_base_fee(&mut self, a: Option<U256>)

Set the block base fee of the header.

pub fn hash(&self) -> H256

Get the hash of this header (keccak of the RLP with seal).

pub fn bare_hash(&self) -> H256

Get the hash of the header excluding the seal

pub fn encoded(&self) -> Header

Encode the header, getting a type-safe wrapper around the RLP.

impl Header

pub fn decode_rlp(
    r: &Rlp<'_>,
    eip1559_transition: BlockNumber
) -> Result<Self, DecoderError>

pub fn decode_rlp_list(
    rlp: &Rlp<'_>,
    eip1559_transition: BlockNumber
) -> Result<Vec<Self>, DecoderError>

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for Header

fn rlp_append(&self, s: &mut RlpStream)

Append a value to the stream

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

Get rlp-encoded bytes for this instance

impl MallocSizeOf for Header

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.

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 PartialEq<Header> for Header

fn eq(&self, c: &Header) -> 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 !=.

impl Eq for Header

impl StructuralEq for Header