Struct SyncStatus 

pub struct SyncStatus {
    pub current_index: Option<i64>,
    pub target_index: Option<i64>,
    pub stage: Option<String>,
    pub synced: Option<bool>,
}

SyncStatus : SyncStatus is used to provide additional context about an implementation’s sync status. This object is often used by implementations to indicate healthiness when block data cannot be queried until some sync phase completes or cannot be determined by comparing the timestamp of the most recent block with the current time.

Fields

current_index: Option<i64>

CurrentIndex is the index of the last synced block in the current stage. This is a separate field from current_block_identifier in NetworkStatusResponse because blocks with indices up to and including the current_index may not yet be queryable by the caller. To reiterate, all indices up to and including current_block_identifier in NetworkStatusResponse must be queryable via the /block endpoint (excluding indices less than oldest_block_identifier).

target_index: Option<i64>

TargetIndex is the index of the block that the implementation is attempting to sync to in the current stage.

stage: Option<String>

Stage is the phase of the sync process.

synced: Option<bool>

synced is a boolean that indicates if an implementation has synced up to the most recent block. If this field is not populated, the caller should rely on a traditional tip timestamp comparison to determine if an implementation is synced. This field is particularly useful for quiescent blockchains (blocks only produced when there are pending transactions). In these blockchains, the most recent block could have a timestamp far behind the current time but the node could be healthy and at tip.

Implementations

impl SyncStatus

pub fn new() -> SyncStatus

SyncStatus is used to provide additional context about an implementation’s sync status. This object is often used by implementations to indicate healthiness when block data cannot be queried until some sync phase completes or cannot be determined by comparing the timestamp of the most recent block with the current time.

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl Default for SyncStatus

fn default() -> SyncStatus

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyncStatus

fn deserialize<__D>( __deserializer: __D, ) -> Result<SyncStatus, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SyncStatus

fn eq(&self, other: &SyncStatus) -> 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 Serialize for SyncStatus

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SyncStatus

impl StructuralPartialEq for SyncStatus