Struct OwnedBeaconChainHeader 

pub struct OwnedBeaconChainHeader { /* private fields */ }

An owned version of BeaconChainHeader.

It is correctly aligned in memory and well suited for sending and receiving over the network efficiently or storing in memory or on disk.

Implementations

impl OwnedBeaconChainHeader

pub const MAX_ALLOCATION: u32

Max allocation needed by this header

pub fn from_parts( prefix: &BlockHeaderPrefix, result: &BlockHeaderResult, consensus_info: &BlockHeaderConsensusInfo, intermediate_shard_blocks_root: &Blake3Hash, consensus_parameters: &BlockHeaderConsensusParameters<'_>, ) -> Result<OwnedBeaconChainHeaderUnsealed, BlockHeaderConsistencyError>

Create a new OwnedBeaconChainHeader from its parts.

Returns an error if the parts are not consistent with each other or with the shard kind.

pub fn from_parts_into<'a>( prefix: &BlockHeaderPrefix, result: &BlockHeaderResult, consensus_info: &BlockHeaderConsensusInfo, intermediate_shard_blocks_root: &Blake3Hash, consensus_parameters: &BlockHeaderConsensusParameters<'_>, buffer: &'a mut OwnedAlignedBuffer, ) -> Result<OwnedBeaconChainHeaderUnsealedRef<'a>, OwnedBeaconChainHeaderError>

Write a header from its parts into the provided buffer, after the bytes already there.

The length of the buffer must be a multiple of 8 for the header to parse. Returns an error if the parts are not consistent with each other or with the shard kind. The seal is not attached, the header in the buffer is complete only after OwnedBeaconChainHeaderUnsealedRef::with_seal() attaches it. Nothing is written when an error is returned, otherwise the seal is guaranteed to fit.

pub fn from_buffer( buffer: SharedAlignedBuffer, ) -> Result<Self, SharedAlignedBuffer>

Create an owned header from a buffer

pub fn buffer(&self) -> &SharedAlignedBuffer

Inner buffer with block header contents

pub fn ref_count(&self) -> usize

Number of clones in memory

pub fn header(&self) -> &BeaconChainHeader<'_>

Get BeaconChainHeader out of OwnedBeaconChainHeader

Trait Implementations

impl Clone for OwnedBeaconChainHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedBeaconChainHeader

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

Formats the value using the given formatter.

impl From<OwnedBeaconChainHeader> for OwnedBlockHeader

fn from(value: OwnedBeaconChainHeader) -> Self

Converts to this type from the input type.

impl GenericOwnedBlockHeader for OwnedBeaconChainHeader

const SHARD_KIND: RealShardKind = RealShardKind::BeaconChain

Shard kind

type Header<'a> = BeaconChainHeader<'a>

Block header

fn from_buffer(buffer: SharedAlignedBuffer) -> Result<Self, SharedAlignedBuffer>

Create an owned header from a buffer

fn buffer(&self) -> &SharedAlignedBuffer

Inner buffer with block header contents

fn ref_count(&self) -> usize

Number of clones in memory

fn header(&self) -> &Self::Header<'_>

Get a regular block header out of the owned version