Struct StaticFileProviderRW 

pub struct StaticFileProviderRW<N> { /* private fields */ }

Available on crate feature provider only.

Extends StaticFileProvider with writing capabilities

Implementations

impl<N> StaticFileProviderRW<N>

where N: NodePrimitives,

pub fn new( segment: StaticFileSegment, block: u64, reader: Weak<StaticFileProviderInner<N>>, metrics: Option<Arc<StaticFileProviderMetrics>>, ) -> Result<StaticFileProviderRW<N>, ProviderError>

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 const fn will_prune_on_commit(&self) -> bool

Returns true if the writer will prune on commit.

pub fn commit(&mut self) -> Result<(), ProviderError>

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

pub fn commit_without_sync_all(&mut self) -> Result<(), ProviderError>

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: u64, ) -> Result<(), ProviderError>

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 next_block_number(&self) -> u64

Returns a block number that is one next to the current tip of static files.

pub fn append_header( &mut self, header: &<N as NodePrimitives>::BlockHeader, hash: &FixedBytes<32>, ) -> Result<(), ProviderError>

where <N as NodePrimitives>::BlockHeader: Compact,

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_header_with_td( &mut self, header: &<N as NodePrimitives>::BlockHeader, total_difficulty: Uint<256, 4>, hash: &FixedBytes<32>, ) -> Result<(), ProviderError>

where <N as NodePrimitives>::BlockHeader: Compact,

Appends header to static file with a specified total difficulty.

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: u64, tx: &<N as NodePrimitives>::SignedTx, ) -> Result<(), ProviderError>

where <N as NodePrimitives>::SignedTx: Compact,

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: u64, receipt: &<N as NodePrimitives>::Receipt, ) -> Result<(), ProviderError>

where <N as NodePrimitives>::Receipt: Compact,

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, ) -> Result<Option<u64>, ProviderError>

where I: Iterator<Item = Result<(u64, R), ProviderError>>, R: Borrow<<N as NodePrimitives>::Receipt>, <N as NodePrimitives>::Receipt: Compact,

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: u64, ) -> Result<(), ProviderError>

Adds an instruction to prune to_delete transactions during commit.

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

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

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) -> Result<(), ProviderError>

Adds an instruction to prune to_delete headers during commit.

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

Helper function to access SegmentHeader.

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

Helper function to access a mutable reference to SegmentHeader.

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

Helper function to override block range for testing.

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

Helper function to override block range for testing.

Trait Implementations

impl<N> Debug for StaticFileProviderRW<N>

where N: Debug,

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

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