Enum Progress

pub enum Progress<HeightOrHash> {
    BeforeGenesis,
    InitialTip(HeightOrHash),
    PreviousCheckpoint(HeightOrHash),
    FinalCheckpoint,
}

A CheckpointVerifier’s current progress verifying the chain.

Variants

BeforeGenesis

We have not verified any blocks yet.

InitialTip(HeightOrHash)

We have verified up to and including this initial tip.

Initial tips might not be one of our hard-coded checkpoints, because we might have:

• changed the checkpoint spacing, or
• added new checkpoints above the initial tip.

PreviousCheckpoint(HeightOrHash)

We have verified up to and including this checkpoint.

FinalCheckpoint

We have finished verifying.

The final checkpoint is not included in this variant. The verifier has finished, so the checkpoints aren’t particularly useful. To get the value of the final checkpoint, use checkpoint_list.max_height().

Implementations

impl Progress<Height>

pub fn height(&self) -> Option<Height>

Returns the contained height, or None if the progress has finished, or has not started.

impl<HeightOrHash> Progress<HeightOrHash>

pub fn is_before_genesis(&self) -> bool

Returns true if the progress is before the genesis block.

pub fn is_final_checkpoint(&self) -> bool

Returns true if the progress is at or after the final checkpoint block.

Trait Implementations

impl<HeightOrHash: Clone> Clone for Progress<HeightOrHash>

fn clone(&self) -> Progress<HeightOrHash>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<HeightOrHash: Debug> Debug for Progress<HeightOrHash>

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

Formats the value using the given formatter.

impl Ord for Progress<Height>

Block height progress, in chain order.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<HeightOrHash: PartialEq> PartialEq for Progress<HeightOrHash>

fn eq(&self, other: &Progress<HeightOrHash>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Progress<Height>

Partial order for block height progress.

The partial order must match the total order.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<HeightOrHash: Copy> Copy for Progress<HeightOrHash>

impl<HeightOrHash: Eq> Eq for Progress<HeightOrHash>

impl<HeightOrHash> StructuralPartialEq for Progress<HeightOrHash>