Struct StaticFileProviderRW

pub struct StaticFileProviderRW { /* private fields */ }

Extends StaticFileProvider with writing capabilities

Implementations

impl StaticFileProviderRW

pub fn new( segment: StaticFileSegment, block: BlockNumber, reader: Weak<StaticFileProviderInner>, metrics: Option<Arc<StaticFileProviderMetrics>>, ) -> ProviderResult<Self>

Creates a new StaticFileProviderRW for a [StaticFileSegment].

Before use, transaction based segments should ensure the block end range is the expected one, and heal if not. For more check Self::ensure_end_range_consistency.

pub fn commit(&mut self) -> ProviderResult<()>

Commits configuration changes to disk and updates the reader index with the new changes.

pub fn commit_without_sync_all(&mut self) -> ProviderResult<()>

Available on crate feature test-utils only.

Commits configuration changes to disk and updates the reader index with the new changes.

CAUTION: does not call sync_all on the files.

pub fn increment_block( &mut self, expected_block_number: BlockNumber, ) -> ProviderResult<BlockNumber>

Allows to increment the [SegmentHeader] end block. It will commit the current static file, and create the next one if we are past the end range.

Returns the current [BlockNumber] as seen in the static file.

pub fn append_header( &mut self, header: &Header, total_difficulty: U256, hash: &BlockHash, ) -> ProviderResult<BlockNumber>

Appends header to static file.

It CALLS increment_block() since the number of headers is equal to the number of blocks.

Returns the current [BlockNumber] as seen in the static file.

pub fn append_transaction( &mut self, tx_num: TxNumber, tx: impl Compact, ) -> ProviderResult<TxNumber>

Appends transaction to static file.

It DOES NOT CALL increment_block(), it should be handled elsewhere. There might be empty blocks and this function wouldn’t be called.

Returns the current [TxNumber] as seen in the static file.

pub fn append_receipt( &mut self, tx_num: TxNumber, receipt: &Receipt, ) -> ProviderResult<TxNumber>

Appends receipt to static file.

It DOES NOT call increment_block(), it should be handled elsewhere. There might be empty blocks and this function wouldn’t be called.

Returns the current [TxNumber] as seen in the static file.

pub fn append_receipts<I, R>( &mut self, receipts: I, ) -> ProviderResult<Option<TxNumber>>

where I: Iterator<Item = Result<(TxNumber, R), ProviderError>>, R: Borrow<Receipt>,

Appends multiple receipts to the static file.

Returns the current [TxNumber] as seen in the static file, if any.

pub fn prune_transactions( &mut self, to_delete: u64, last_block: BlockNumber, ) -> ProviderResult<()>

Adds an instruction to prune to_deletetransactions during commit.

Note: last_block refers to the block the unwinds ends at.

pub fn prune_receipts( &mut self, to_delete: u64, last_block: BlockNumber, ) -> ProviderResult<()>

Adds an instruction to prune to_delete receipts during commit.

Note: last_block refers to the block the unwinds ends at.

pub fn prune_headers(&mut self, to_delete: u64) -> ProviderResult<()>

Adds an instruction to prune to_delete headers during commit.

pub const fn user_header(&self) -> &SegmentHeader

Helper function to access [SegmentHeader].

pub fn user_header_mut(&mut self) -> &mut SegmentHeader

Helper function to access a mutable reference to [SegmentHeader].

pub fn set_block_range(&mut self, block_range: RangeInclusive<BlockNumber>)

Available on crate feature test-utils only.

Helper function to override block range for testing.

pub fn inner(&mut self) -> &mut NippyJarWriter<SegmentHeader>

Available on crate feature test-utils only.

Helper function to override block range for testing.

Trait Implementations

impl Debug for StaticFileProviderRW

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