Struct grin_chain::types::SyncState

pub struct SyncState { /* private fields */ }

Current sync state. Encapsulates the current SyncStatus.

Implementations

impl SyncState

pub fn new() -> SyncState

Return a new SyncState initialize to NoSync

pub fn reset(&self)

Reset sync status to NoSync.

pub fn is_syncing(&self) -> bool

Whether the current state matches any active syncing operation. Note: This includes our “initial” state.

pub fn status(&self) -> SyncStatus

Current syncing status

pub fn update(&self, new_status: SyncStatus) -> bool

Update the syncing status

pub fn update_if<F>(&self, new_status: SyncStatus, f: F) -> bool

where F: Fn(SyncStatus) -> bool,

Update the syncing status if predicate f is satisfied

pub fn update_header_sync(&self, new_sync_head: Tip)

Update sync_head if state is currently HeaderSync.

pub fn update_txhashset_download(&self, stats: TxHashsetDownloadStats)

Update txhashset downloading progress

pub fn update_pibd_progress( &self, aborted: bool, errored: bool, completed_leaves: u64, completed_to_height: u64, archive_header: &BlockHeader )

Update PIBD progress

pub fn add_pibd_segment(&self, id: &SegmentTypeIdentifier)

Update PIBD segment list

pub fn remove_pibd_segment(&self, id: &SegmentTypeIdentifier)

Remove segment from list

pub fn remove_stale_pibd_requests(&self, timeout_seconds: i64)

Remove segments with request timestamps less than cutoff time

pub fn contains_pibd_segment(&self, id: &SegmentTypeIdentifier) -> bool

Check whether segment is in request list

pub fn set_sync_error(&self, error: Error)

Communicate sync error

pub fn sync_error(&self) -> Option<String>

Get sync error

pub fn clear_sync_error(&self)

Clear sync error

Trait Implementations

impl TxHashsetWriteStatus for SyncState

fn on_setup( &self, headers: Option<u64>, headers_total: Option<u64>, kernel_pos: Option<u64>, kernel_pos_total: Option<u64> )

First setup of the txhashset

fn on_validation_kernels(&self, kernels: u64, kernels_total: u64)

Starting kernel validation

fn on_validation_rproofs(&self, rproofs: u64, rproofs_total: u64)

Starting rproof validation

fn on_save(&self)

Starting to save the txhashset and related data

fn on_done(&self)

Done writing a new txhashset