Struct StaticFileProviderRWRefMut 

pub struct StaticFileProviderRWRefMut<'a, N>(/* private fields */);

Mutable reference to a StaticFileProviderRW behind a [RwLockWriteGuard].

Methods from Deref<Target = StaticFileProviderRW<N>>

pub fn will_prune_on_commit(&self) -> bool

Returns true if the writer will prune on commit.

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 ensure_at_block(&mut self, advance_to: BlockNumber) -> ProviderResult<()>

Ensures that the writer is positioned at the specified block number.

If the writer is positioned at a greater block number than the specified one, the writer will NOT be unwound and the error will be returned.

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

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.

pub fn current_block_number(&self) -> Option<u64>

Returns the current block number of the static file writer.

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::BlockHeader, hash: &BlockHash, ) -> ProviderResult<()>

where N::BlockHeader: Compact,

Appends header to static file.

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

pub fn append_header_with_td( &mut self, header: &N::BlockHeader, total_difficulty: U256, hash: &BlockHash, ) -> ProviderResult<()>

where N::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.

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

where N::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.

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

where N::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.

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

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

Appends multiple receipts to the static file.

pub fn append_transaction_sender( &mut self, tx_num: TxNumber, sender: &Address, ) -> ProviderResult<()>

Appends transaction sender 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.

pub fn append_transaction_senders<I>( &mut self, senders: I, ) -> ProviderResult<()>

where I: Iterator<Item = (TxNumber, Address)>,

Appends multiple transaction senders to the static file.

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

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: 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_transaction_senders( &mut self, to_delete: u64, last_block: BlockNumber, ) -> ProviderResult<()>

Adds an instruction to prune to_delete transaction senders 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 fn reader(&self) -> StaticFileProvider<N>

Returns a StaticFileProvider associated with this writer.

pub 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 features test-utils only.

Helper function to override block range for testing.

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

Available on crate features test-utils only.

Helper function to override block range for testing.

Trait Implementations

impl<'a, N: Debug> Debug for StaticFileProviderRWRefMut<'a, N>

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

Formats the value using the given formatter.

impl<N> Deref for StaticFileProviderRWRefMut<'_, N>

type Target = StaticFileProviderRW<N>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<N> DerefMut for StaticFileProviderRWRefMut<'_, N>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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