Struct StageCheckpoint

pub struct StageCheckpoint {
    pub block_number: u64,
    pub stage_checkpoint: Option<StageUnitCheckpoint>,
}

Saves the progress of a stage.

Fields

block_number: u64

The maximum block processed by the stage.

stage_checkpoint: Option<StageUnitCheckpoint>

Stage-specific checkpoint. None if stage uses only block-based checkpoints.

Implementations

impl StageCheckpoint

pub const fn bitflag_encoded_bytes() -> usize

Used bytes by [StageCheckpointFlags]

pub const fn bitflag_unused_bits() -> usize

Unused bits for new fields by [StageCheckpointFlags]

impl StageCheckpoint

pub fn new(block_number: u64) -> StageCheckpoint

Creates a new StageCheckpoint with only block_number set.

pub const fn with_block_number(self, block_number: u64) -> StageCheckpoint

Sets the block number.

pub fn with_block_range( self, stage_id: &StageId, from: u64, to: u64, ) -> StageCheckpoint

Sets the block range, if checkpoint uses block range.

pub fn entities(&self) -> Option<EntitiesCheckpoint>

Get the underlying EntitiesCheckpoint, if any, to determine the number of entities processed, and the number of total entities to process.

impl StageCheckpoint

pub const fn account_hashing_stage_checkpoint( &self, ) -> Option<AccountHashingCheckpoint>

Returns the account hashing stage checkpoint, if any.

pub const fn with_account_hashing_stage_checkpoint( self, checkpoint: AccountHashingCheckpoint, ) -> StageCheckpoint

Sets the stage checkpoint to account hashing.

pub const fn storage_hashing_stage_checkpoint( &self, ) -> Option<StorageHashingCheckpoint>

Returns the storage hashing stage checkpoint, if any.

pub const fn with_storage_hashing_stage_checkpoint( self, checkpoint: StorageHashingCheckpoint, ) -> StageCheckpoint

Sets the stage checkpoint to storage hashing.

pub const fn entities_stage_checkpoint(&self) -> Option<EntitiesCheckpoint>

Returns the entities stage checkpoint, if any.

pub const fn with_entities_stage_checkpoint( self, checkpoint: EntitiesCheckpoint, ) -> StageCheckpoint

Sets the stage checkpoint to entities.

pub const fn execution_stage_checkpoint(&self) -> Option<ExecutionCheckpoint>

Returns the execution stage checkpoint, if any.

pub const fn with_execution_stage_checkpoint( self, checkpoint: ExecutionCheckpoint, ) -> StageCheckpoint

Sets the stage checkpoint to execution.

pub const fn headers_stage_checkpoint(&self) -> Option<HeadersCheckpoint>

Returns the headers stage checkpoint, if any.

pub const fn with_headers_stage_checkpoint( self, checkpoint: HeadersCheckpoint, ) -> StageCheckpoint

Sets the stage checkpoint to headers.

pub const fn index_history_stage_checkpoint( &self, ) -> Option<IndexHistoryCheckpoint>

Returns the index history stage checkpoint, if any.

pub const fn with_index_history_stage_checkpoint( self, checkpoint: IndexHistoryCheckpoint, ) -> StageCheckpoint

Sets the stage checkpoint to index history.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for StageCheckpoint

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StageCheckpoint, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<StageCheckpoint, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for StageCheckpoint

fn clone(&self) -> StageCheckpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Compact for StageCheckpoint

fn to_compact<B>(&self, buf: &mut B) -> usize

where B: BufMut + AsMut<[u8]>,

Takes a buffer which can be written to. Ideally, it returns the length written to.

fn from_compact(buf: &[u8], len: usize) -> (StageCheckpoint, &[u8])

Takes a buffer which can be read from. Returns the object and buf with its internal cursor advanced (eg..advance(len)).

fn specialized_to_compact<B>(&self, buf: &mut B) -> usize

where B: BufMut + AsMut<[u8]>,

“Optional”: If there’s no good reason to use it, don’t.

fn specialized_from_compact(buf: &[u8], len: usize) -> (Self, &[u8])

“Optional”: If there’s no good reason to use it, don’t.

impl Compress for StageCheckpoint

type Compressed = Vec<u8>

Compressed type.

fn compress_to_buf<B>(self, buf: &mut B)

where B: BufMut + AsMut<[u8]>,

Compresses data to a given buffer.

fn uncompressable_ref(&self) -> Option<&[u8]>

If the type cannot be compressed, return its inner reference as Some(self.as_ref())

fn compress(self) -> Self::Compressed

Compresses data going into the database.

impl Debug for StageCheckpoint

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

Formats the value using the given formatter.

impl Decompress for StageCheckpoint

fn decompress(value: &[u8]) -> Result<StageCheckpoint, DatabaseError>

Decompresses data coming from the database.

fn decompress_owned(value: Vec<u8>) -> Result<Self, DatabaseError>

Decompresses owned data coming from the database.

impl Default for StageCheckpoint

fn default() -> StageCheckpoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StageCheckpoint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StageCheckpoint

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

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 Copy for StageCheckpoint

impl Eq for StageCheckpoint

impl StructuralPartialEq for StageCheckpoint

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 96 bytes