Enum SyncStatus

pub enum SyncStatus {
    AwaitingPeers,
    NoSync,
    EpochSync {
        epoch_ord: u64,
    },
    HeaderSync {
        start_height: BlockHeight,
        current_height: BlockHeight,
        highest_height: BlockHeight,
    },
    StateSync(StateSyncStatus),
    StateSyncDone,
    BlockSync {
        start_height: BlockHeight,
        current_height: BlockHeight,
        highest_height: BlockHeight,
    },
}

Various status sync can be in, whether it’s fast sync or archival.

Variants

AwaitingPeers

Initial state. Not enough peers to do anything yet.

NoSync

Not syncing / Done syncing.

EpochSync

Syncing using light-client headers to a recent epoch

Fields

epoch_ord: u64

HeaderSync

Downloading block headers for fast sync.

Fields

start_height: BlockHeight

Head height at the beginning. Not the header head height! Used only for reporting the progress of the sync.

current_height: BlockHeight

Current header head height.

highest_height: BlockHeight

Highest height of our peers.

StateSync(StateSyncStatus)

State sync, with different states of state sync for different shards.

StateSyncDone

Sync state across all shards is done.

BlockSync

Download and process blocks until the head reaches the head of the network.

Fields

start_height: BlockHeight

Header head height at the beginning. Used only for reporting the progress of the sync.

current_height: BlockHeight

Current head height.

highest_height: BlockHeight

Highest height of our peers.

Implementations

impl SyncStatus

pub fn as_variant_name(&self) -> &str

Get a string representation of the status variant

pub fn is_syncing(&self) -> bool

True if currently engaged in syncing the chain.

pub fn repr(&self) -> u8

pub fn start_height(&self) -> Option<BlockHeight>

pub fn update(&mut self, new_value: Self)

Trait Implementations

impl AsRef<str> for SyncStatus

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SyncStatus

fn clone(&self) -> SyncStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyncStatus

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

Formats the value using the given formatter.

impl From<SyncStatus> for SyncStatusView

fn from(status: SyncStatus) -> Self

Converts to this type from the input type.