Struct UnifiedStorageWriter

pub struct UnifiedStorageWriter<'a, ProviderDB, ProviderSF> { /* private fields */ }

Available on crate feature provider only.

UnifiedStorageWriter is responsible for managing the writing to storage with both database and static file providers.

Implementations

impl<'a, ProviderDB, ProviderSF> UnifiedStorageWriter<'a, ProviderDB, ProviderSF>

pub const fn new( database: &'a ProviderDB, static_file: Option<ProviderSF>, ) -> UnifiedStorageWriter<'a, ProviderDB, ProviderSF>

Creates a new instance of UnifiedStorageWriter.

Parameters

• database: An optional reference to a database provider.
• static_file: An optional mutable reference to a static file instance.

pub fn from<P>( database: &'a P, static_file: ProviderSF, ) -> UnifiedStorageWriter<'a, ProviderDB, ProviderSF>

where P: AsRef<ProviderDB>,

Creates a new instance of UnifiedStorageWriter from a database provider and a static file instance.

pub fn from_database<P>( database: &'a P, ) -> UnifiedStorageWriter<'a, ProviderDB, ProviderSF>

where P: AsRef<ProviderDB>,

Creates a new instance of UnifiedStorageWriter from a database provider.

impl UnifiedStorageWriter<'_, (), ()>

pub fn commit<P>(provider: P) -> Result<(), ProviderError>

where P: DBProvider + StaticFileProviderFactory, <P as DBProvider>::Tx: DbTxMut,

Commits both storage types in the right order.

For non-unwinding operations it makes more sense to commit the static files first, since if it is interrupted before the database commit, we can just truncate the static files according to the checkpoints on the next start-up.

NOTE: If unwinding data from storage, use commit_unwind instead!

pub fn commit_unwind<P>(provider: P) -> Result<(), ProviderError>

where P: DBProvider + StaticFileProviderFactory, <P as DBProvider>::Tx: DbTxMut,

Commits both storage types in the right order for an unwind operation.

For unwinding it makes more sense to commit the database first, since if it is interrupted before the static files commit, we can just truncate the static files according to the checkpoints on the next start-up.

NOTE: Should only be used after unwinding data from storage!

impl<ProviderDB> UnifiedStorageWriter<'_, ProviderDB, &StaticFileProvider<<ProviderDB as NodePrimitivesProvider>::Primitives>>

where ProviderDB: DBProvider + BlockWriter + TransactionsProviderExt + TrieWriter + StateWriter + HistoryWriter + StageCheckpointWriter + BlockExecutionWriter + AsRef<ProviderDB> + StaticFileProviderFactory, <ProviderDB as DBProvider>::Tx: DbTx + DbTxMut,

pub fn save_blocks<N>( &self, blocks: Vec<ExecutedBlockWithTrieUpdates<N>>, ) -> Result<(), ProviderError>

where N: NodePrimitives, <N as NodePrimitives>::SignedTx: SignedTransaction, ProviderDB: BlockWriter<Block = <N as NodePrimitives>::Block> + StateWriter<Receipt = <N as NodePrimitives>::Receipt>,

Writes executed blocks and receipts to storage.

pub fn remove_blocks_above( &self, block_number: u64, ) -> Result<(), ProviderError>

Removes all block, transaction and receipt data above the given block number from the database and static files. This is exclusive, i.e., it only removes blocks above block_number, and does not remove block_number.

Trait Implementations

impl<'a, ProviderDB, ProviderSF> Debug for UnifiedStorageWriter<'a, ProviderDB, ProviderSF>

where ProviderDB: Debug, ProviderSF: Debug,

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

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.