Struct sp_blockchain::TreeRoute

pub struct TreeRoute<Block: BlockT> { /* private fields */ }

A tree-route from one block to another in the chain.

All blocks prior to the pivot in the vector is the reverse-order unique ancestry of the first block, the block at the pivot index is the common ancestor, and all blocks after the pivot is the ancestry of the second block, in order.

The ancestry sets will include the given blocks, and thus the tree-route is never empty.

Tree route from R1 to E2. Retracted is [R1, R2, R3], Common is C, enacted [E1, E2]
  <- R3 <- R2 <- R1
 /
C
 \-> E1 -> E2

Tree route from C to E2. Retracted empty. Common is C, enacted [E1, E2]
C -> E1 -> E2

Implementations

impl<Block: BlockT> TreeRoute<Block>

pub fn new( route: Vec<HashAndNumber<Block>>, pivot: usize, ) -> Result<Self, String>

Creates a new TreeRoute.

To preserve the structure safety invariants it is required that pivot < route.len().

pub fn retracted(&self) -> &[HashAndNumber<Block>]

Get a slice of all retracted blocks in reverse order (towards common ancestor).

pub fn into_retracted(self) -> Vec<HashAndNumber<Block>>

Convert into all retracted blocks in reverse order (towards common ancestor).

pub fn common_block(&self) -> &HashAndNumber<Block>

Get the common ancestor block. This might be one of the two blocks of the route.

pub fn enacted(&self) -> &[HashAndNumber<Block>]

Get a slice of enacted blocks (descendants of the common ancestor)

pub fn last(&self) -> Option<&HashAndNumber<Block>>

Returns the last block.

Trait Implementations

impl<Block: Clone + BlockT> Clone for TreeRoute<Block>

fn clone(&self) -> TreeRoute<Block>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Block: Debug + BlockT> Debug for TreeRoute<Block>

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

Formats the value using the given formatter.