Struct PersistenceHandle

pub struct PersistenceHandle<N: NodePrimitives = EthPrimitives> { /* private fields */ }

A handle to the persistence service

Implementations

impl<T: NodePrimitives> PersistenceHandle<T>

pub const fn new(sender: Sender<PersistenceAction<T>>) -> Self

Create a new PersistenceHandle from a Sender<PersistenceAction>.

pub fn spawn_service<N>( provider_factory: ProviderFactory<N>, pruner: PrunerWithFactory<ProviderFactory<N>>, sync_metrics_tx: MetricEventsSender, ) -> PersistenceHandle<N::Primitives>

where N: ProviderNodeTypes,

Create a new PersistenceHandle, and spawn the persistence service.

pub fn send_action( &self, action: PersistenceAction<T>, ) -> Result<(), SendError<PersistenceAction<T>>>

Sends a specific PersistenceAction in the contained channel. The caller is responsible for creating any channels for the given action.

pub fn save_blocks( &self, blocks: Vec<ExecutedBlock<T>>, tx: Sender<Option<BlockNumHash>>, ) -> Result<(), SendError<PersistenceAction<T>>>

Tells the persistence service to save a certain list of finalized blocks. The blocks are assumed to be ordered by block number.

This returns the latest hash that has been saved, allowing removal of that block and any previous blocks from in-memory data structures. This value is returned in the receiver end of the sender argument.

If there are no blocks to persist, then None is sent in the sender.

pub fn save_finalized_block_number( &self, finalized_block: u64, ) -> Result<(), SendError<PersistenceAction<T>>>

Persists the finalized block number on disk.

pub fn save_safe_block_number( &self, safe_block: u64, ) -> Result<(), SendError<PersistenceAction<T>>>

Persists the finalized block number on disk.

pub fn remove_blocks_above( &self, block_num: u64, tx: Sender<Option<BlockNumHash>>, ) -> Result<(), SendError<PersistenceAction<T>>>

Tells the persistence service to remove blocks above a certain block number. The removed blocks are returned by the service.

When the operation completes, the new tip hash is returned in the receiver end of the sender argument.

Trait Implementations

impl<N: Clone + NodePrimitives> Clone for PersistenceHandle<N>

fn clone(&self) -> PersistenceHandle<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + NodePrimitives> Debug for PersistenceHandle<N>

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

Formats the value using the given formatter.

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: 16 bytes