Struct BlockchainProvider
pub struct BlockchainProvider<N>where
N: NodeTypesWithDB,{ /* private fields */ }
provider
only.Expand description
The main type for interacting with the blockchain.
This type serves as the main entry point for interacting with the blockchain and provides data from database storage and from the blockchain tree (pending state etc.) It is a simple wrapper type that holds an instance of the database and the blockchain tree.
Implementations§
§impl<N> BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> BlockchainProvider<N>where
N: ProviderNodeTypes,
pub fn new(
storage: ProviderFactory<N>,
) -> Result<BlockchainProvider<N>, ProviderError>
pub fn new( storage: ProviderFactory<N>, ) -> Result<BlockchainProvider<N>, ProviderError>
Create a new BlockchainProvider
using only the storage, fetching the latest
header from the database to initialize the provider.
pub fn with_latest(
storage: ProviderFactory<N>,
latest: SealedHeader<<<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader>,
) -> Result<BlockchainProvider<N>, ProviderError>
pub fn with_latest( storage: ProviderFactory<N>, latest: SealedHeader<<<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader>, ) -> Result<BlockchainProvider<N>, ProviderError>
Create new provider instance that wraps the database and the blockchain tree, using the provided latest header to initialize the chain info tracker.
This returns a ProviderResult
since it tries the retrieve the last finalized header from
database
.
pub fn canonical_in_memory_state(
&self,
) -> CanonicalInMemoryState<<N as NodeTypes>::Primitives>
pub fn canonical_in_memory_state( &self, ) -> CanonicalInMemoryState<<N as NodeTypes>::Primitives>
Gets a clone of canonical_in_memory_state
.
pub fn consistent_provider(
&self,
) -> Result<ConsistentProvider<N>, ProviderError>
pub fn consistent_provider( &self, ) -> Result<ConsistentProvider<N>, ProviderError>
Returns a provider with a created DbTx
inside, which allows fetching data from the
database using different types of providers. Example: HeaderProvider
BlockHashReader
. This may fail if the inner read database transaction fails to open.
pub fn get_state(
&self,
range: RangeInclusive<u64>,
) -> Result<Option<ExecutionOutcome<<<N as NodeTypes>::Primitives as NodePrimitives>::Receipt>>, ProviderError>
pub fn get_state( &self, range: RangeInclusive<u64>, ) -> Result<Option<ExecutionOutcome<<<N as NodeTypes>::Primitives as NodePrimitives>::Receipt>>, ProviderError>
Return the last N blocks of state, recreating the ExecutionOutcome
.
If the range is empty, or there are no blocks for the given range, then this returns None
.
Trait Implementations§
§impl<N> AccountReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> AccountReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn basic_account(
&self,
address: &Address,
) -> Result<Option<Account>, ProviderError>
fn basic_account( &self, address: &Address, ) -> Result<Option<Account>, ProviderError>
Get basic account information.
§impl<N> BlockBodyIndicesProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> BlockBodyIndicesProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn block_body_indices(
&self,
number: u64,
) -> Result<Option<StoredBlockBodyIndices>, ProviderError>
fn block_body_indices( &self, number: u64, ) -> Result<Option<StoredBlockBodyIndices>, ProviderError>
§fn block_body_indices_range(
&self,
range: RangeInclusive<u64>,
) -> Result<Vec<StoredBlockBodyIndices>, ProviderError>
fn block_body_indices_range( &self, range: RangeInclusive<u64>, ) -> Result<Vec<StoredBlockBodyIndices>, ProviderError>
§impl<N> BlockHashReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> BlockHashReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn block_hash(
&self,
number: u64,
) -> Result<Option<FixedBytes<32>>, ProviderError>
fn block_hash( &self, number: u64, ) -> Result<Option<FixedBytes<32>>, ProviderError>
None
if no block with this number
exists.§fn canonical_hashes_range(
&self,
start: u64,
end: u64,
) -> Result<Vec<FixedBytes<32>>, ProviderError>
fn canonical_hashes_range( &self, start: u64, end: u64, ) -> Result<Vec<FixedBytes<32>>, ProviderError>
§fn convert_block_hash(
&self,
hash_or_number: HashOrNumber,
) -> Result<Option<FixedBytes<32>>, ProviderError>
fn convert_block_hash( &self, hash_or_number: HashOrNumber, ) -> Result<Option<FixedBytes<32>>, ProviderError>
None
if no block with this number
exists.§impl<N> BlockIdReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> BlockIdReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn pending_block_num_hash(&self) -> Result<Option<NumHash>, ProviderError>
fn pending_block_num_hash(&self) -> Result<Option<NumHash>, ProviderError>
§fn safe_block_num_hash(&self) -> Result<Option<NumHash>, ProviderError>
fn safe_block_num_hash(&self) -> Result<Option<NumHash>, ProviderError>
§fn finalized_block_num_hash(&self) -> Result<Option<NumHash>, ProviderError>
fn finalized_block_num_hash(&self) -> Result<Option<NumHash>, ProviderError>
§fn convert_block_number(
&self,
num: BlockNumberOrTag,
) -> Result<Option<u64>, ProviderError>
fn convert_block_number( &self, num: BlockNumberOrTag, ) -> Result<Option<u64>, ProviderError>
BlockNumberOrTag
variants to a block number.§fn block_hash_for_id(
&self,
block_id: BlockId,
) -> Result<Option<FixedBytes<32>>, ProviderError>
fn block_hash_for_id( &self, block_id: BlockId, ) -> Result<Option<FixedBytes<32>>, ProviderError>
§fn block_number_for_id(
&self,
block_id: BlockId,
) -> Result<Option<u64>, ProviderError>
fn block_number_for_id( &self, block_id: BlockId, ) -> Result<Option<u64>, ProviderError>
§fn safe_block_number(&self) -> Result<Option<u64>, ProviderError>
fn safe_block_number(&self) -> Result<Option<u64>, ProviderError>
§fn finalized_block_number(&self) -> Result<Option<u64>, ProviderError>
fn finalized_block_number(&self) -> Result<Option<u64>, ProviderError>
§fn safe_block_hash(&self) -> Result<Option<FixedBytes<32>>, ProviderError>
fn safe_block_hash(&self) -> Result<Option<FixedBytes<32>>, ProviderError>
§fn finalized_block_hash(&self) -> Result<Option<FixedBytes<32>>, ProviderError>
fn finalized_block_hash(&self) -> Result<Option<FixedBytes<32>>, ProviderError>
§impl<N> BlockNumReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> BlockNumReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn chain_info(&self) -> Result<ChainInfo, ProviderError>
fn chain_info(&self) -> Result<ChainInfo, ProviderError>
§fn best_block_number(&self) -> Result<u64, ProviderError>
fn best_block_number(&self) -> Result<u64, ProviderError>
§fn last_block_number(&self) -> Result<u64, ProviderError>
fn last_block_number(&self) -> Result<u64, ProviderError>
§fn block_number(
&self,
hash: FixedBytes<32>,
) -> Result<Option<u64>, ProviderError>
fn block_number( &self, hash: FixedBytes<32>, ) -> Result<Option<u64>, ProviderError>
BlockNumber
for the given hash. Returns None
if no block with this hash exists.§fn convert_hash_or_number(
&self,
id: HashOrNumber,
) -> Result<Option<u64>, ProviderError>
fn convert_hash_or_number( &self, id: HashOrNumber, ) -> Result<Option<u64>, ProviderError>
BlockHashOrNumber
. Returns None
if no block with
this hash exists. If the BlockHashOrNumber
is a Number
, it is returned as is.§fn convert_number(
&self,
id: HashOrNumber,
) -> Result<Option<FixedBytes<32>>, ProviderError>
fn convert_number( &self, id: HashOrNumber, ) -> Result<Option<FixedBytes<32>>, ProviderError>
BlockHashOrNumber
. Returns None
if no block with this
number exists. If the BlockHashOrNumber
is a Hash
, it is returned as is.§impl<N> BlockReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> BlockReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn recovered_block(
&self,
id: HashOrNumber,
transaction_kind: TransactionVariant,
) -> Result<Option<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
fn recovered_block( &self, id: HashOrNumber, transaction_kind: TransactionVariant, ) -> Result<Option<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
Returns the block with senders with matching number or hash from database.
NOTE: If TransactionVariant::NoHash
is provided then the transactions have invalid
hashes, since they would need to be calculated on the spot, and we want fast querying.
Returns None
if block is not found.
§type Block = <<N as NodeTypes>::Primitives as NodePrimitives>::Block
type Block = <<N as NodeTypes>::Primitives as NodePrimitives>::Block
§fn find_block_by_hash(
&self,
hash: FixedBytes<32>,
source: BlockSource,
) -> Result<Option<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
fn find_block_by_hash( &self, hash: FixedBytes<32>, source: BlockSource, ) -> Result<Option<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
§fn block(
&self,
id: HashOrNumber,
) -> Result<Option<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
fn block( &self, id: HashOrNumber, ) -> Result<Option<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
§fn pending_block(
&self,
) -> Result<Option<SealedBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
fn pending_block( &self, ) -> Result<Option<SealedBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
§fn pending_block_with_senders(
&self,
) -> Result<Option<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
fn pending_block_with_senders( &self, ) -> Result<Option<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
§fn pending_block_and_receipts(
&self,
) -> Result<Option<(SealedBlock<<BlockchainProvider<N> as BlockReader>::Block>, Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>)>, ProviderError>
fn pending_block_and_receipts( &self, ) -> Result<Option<(SealedBlock<<BlockchainProvider<N> as BlockReader>::Block>, Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>)>, ProviderError>
§fn sealed_block_with_senders(
&self,
id: HashOrNumber,
transaction_kind: TransactionVariant,
) -> Result<Option<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
fn sealed_block_with_senders( &self, id: HashOrNumber, transaction_kind: TransactionVariant, ) -> Result<Option<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
§fn block_range(
&self,
range: RangeInclusive<u64>,
) -> Result<Vec<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
fn block_range( &self, range: RangeInclusive<u64>, ) -> Result<Vec<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
§fn block_with_senders_range(
&self,
range: RangeInclusive<u64>,
) -> Result<Vec<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
fn block_with_senders_range( &self, range: RangeInclusive<u64>, ) -> Result<Vec<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
§fn recovered_block_range(
&self,
range: RangeInclusive<u64>,
) -> Result<Vec<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
fn recovered_block_range( &self, range: RangeInclusive<u64>, ) -> Result<Vec<RecoveredBlock<<BlockchainProvider<N> as BlockReader>::Block>>, ProviderError>
§fn block_by_hash(
&self,
hash: FixedBytes<32>,
) -> Result<Option<Self::Block>, ProviderError>
fn block_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<Self::Block>, ProviderError>
§fn block_by_number(
&self,
num: u64,
) -> Result<Option<Self::Block>, ProviderError>
fn block_by_number( &self, num: u64, ) -> Result<Option<Self::Block>, ProviderError>
§impl<N> BlockReaderIdExt for BlockchainProvider<N>
impl<N> BlockReaderIdExt for BlockchainProvider<N>
§fn block_by_id(
&self,
id: BlockId,
) -> Result<Option<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
fn block_by_id( &self, id: BlockId, ) -> Result<Option<<BlockchainProvider<N> as BlockReader>::Block>, ProviderError>
§fn header_by_number_or_tag(
&self,
id: BlockNumberOrTag,
) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
fn header_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
§fn sealed_header_by_number_or_tag(
&self,
id: BlockNumberOrTag,
) -> Result<Option<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
fn sealed_header_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
§fn sealed_header_by_id(
&self,
id: BlockId,
) -> Result<Option<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
fn sealed_header_by_id( &self, id: BlockId, ) -> Result<Option<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
BlockId
from the database. Read more§fn header_by_id(
&self,
id: BlockId,
) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
fn header_by_id( &self, id: BlockId, ) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
BlockId
from the database. Read more§fn ommers_by_id(
&self,
id: BlockId,
) -> Result<Option<Vec<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
fn ommers_by_id( &self, id: BlockId, ) -> Result<Option<Vec<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
BlockId
from the database. Read more§fn block_by_number_or_tag(
&self,
id: BlockNumberOrTag,
) -> Result<Option<Self::Block>, ProviderError>
fn block_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<Self::Block>, ProviderError>
§fn pending_header(
&self,
) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
fn pending_header( &self, ) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
§fn latest_header(
&self,
) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
fn latest_header( &self, ) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
§fn safe_header(
&self,
) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
fn safe_header( &self, ) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
§fn finalized_header(
&self,
) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
fn finalized_header( &self, ) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
§fn block_with_senders_by_id(
&self,
id: BlockId,
transaction_kind: TransactionVariant,
) -> Result<Option<RecoveredBlock<Self::Block>>, ProviderError>
fn block_with_senders_by_id( &self, id: BlockId, transaction_kind: TransactionVariant, ) -> Result<Option<RecoveredBlock<Self::Block>>, ProviderError>
§fn ommers_by_number_or_tag(
&self,
id: BlockNumberOrTag,
) -> Result<Option<Vec<Self::Header>>, ProviderError>
fn ommers_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<Vec<Self::Header>>, ProviderError>
§impl<N> CanonChainTracker for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> CanonChainTracker for BlockchainProvider<N>where
N: ProviderNodeTypes,
§type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader
type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader
§fn on_forkchoice_update_received(&self, _update: &ForkchoiceState)
fn on_forkchoice_update_received(&self, _update: &ForkchoiceState)
§fn last_received_update_timestamp(&self) -> Option<Instant>
fn last_received_update_timestamp(&self) -> Option<Instant>
std
only.CanonChainTracker::on_forkchoice_update_received
)§fn on_transition_configuration_exchanged(&self)
fn on_transition_configuration_exchanged(&self)
§fn last_exchanged_transition_configuration_timestamp(&self) -> Option<Instant>
fn last_exchanged_transition_configuration_timestamp(&self) -> Option<Instant>
std
only.CanonChainTracker::on_transition_configuration_exchanged
)§fn set_canonical_head(
&self,
header: SealedHeader<<BlockchainProvider<N> as CanonChainTracker>::Header>,
)
fn set_canonical_head( &self, header: SealedHeader<<BlockchainProvider<N> as CanonChainTracker>::Header>, )
§fn set_safe(
&self,
header: SealedHeader<<BlockchainProvider<N> as CanonChainTracker>::Header>,
)
fn set_safe( &self, header: SealedHeader<<BlockchainProvider<N> as CanonChainTracker>::Header>, )
§fn set_finalized(
&self,
header: SealedHeader<<BlockchainProvider<N> as CanonChainTracker>::Header>,
)
fn set_finalized( &self, header: SealedHeader<<BlockchainProvider<N> as CanonChainTracker>::Header>, )
§impl<N> CanonStateSubscriptions for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> CanonStateSubscriptions for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn subscribe_to_canonical_state(
&self,
) -> Receiver<CanonStateNotification<<BlockchainProvider<N> as NodePrimitivesProvider>::Primitives>>
fn subscribe_to_canonical_state( &self, ) -> Receiver<CanonStateNotification<<BlockchainProvider<N> as NodePrimitivesProvider>::Primitives>>
§fn canonical_state_stream(
&self,
) -> CanonStateNotificationStream<Self::Primitives>
fn canonical_state_stream( &self, ) -> CanonStateNotificationStream<Self::Primitives>
CanonStateNotification
.§impl<N> ChainSpecProvider for BlockchainProvider<N>where
N: NodeTypesWithDB,
impl<N> ChainSpecProvider for BlockchainProvider<N>where
N: NodeTypesWithDB,
§impl<N> ChangeSetReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> ChangeSetReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn account_block_changeset(
&self,
block_number: u64,
) -> Result<Vec<AccountBeforeTx>, ProviderError>
fn account_block_changeset( &self, block_number: u64, ) -> Result<Vec<AccountBeforeTx>, ProviderError>
§impl<N> Clone for BlockchainProvider<N>where
N: NodeTypesWithDB,
impl<N> Clone for BlockchainProvider<N>where
N: NodeTypesWithDB,
§fn clone(&self) -> BlockchainProvider<N>
fn clone(&self) -> BlockchainProvider<N>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<N> DatabaseProviderFactory for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> DatabaseProviderFactory for BlockchainProvider<N>where
N: ProviderNodeTypes,
§type DB = <N as NodeTypesWithDB>::DB
type DB = <N as NodeTypesWithDB>::DB
§type Provider = <ProviderFactory<N> as DatabaseProviderFactory>::Provider
type Provider = <ProviderFactory<N> as DatabaseProviderFactory>::Provider
§type ProviderRW = <ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW
type ProviderRW = <ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW
§fn database_provider_ro(
&self,
) -> Result<<BlockchainProvider<N> as DatabaseProviderFactory>::Provider, ProviderError>
fn database_provider_ro( &self, ) -> Result<<BlockchainProvider<N> as DatabaseProviderFactory>::Provider, ProviderError>
§fn database_provider_rw(
&self,
) -> Result<<BlockchainProvider<N> as DatabaseProviderFactory>::ProviderRW, ProviderError>
fn database_provider_rw( &self, ) -> Result<<BlockchainProvider<N> as DatabaseProviderFactory>::ProviderRW, ProviderError>
§impl<N> Debug for BlockchainProvider<N>
impl<N> Debug for BlockchainProvider<N>
§impl<N> ForkChoiceSubscriptions for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> ForkChoiceSubscriptions for BlockchainProvider<N>where
N: ProviderNodeTypes,
§type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader
type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader
§fn subscribe_safe_block(
&self,
) -> ForkChoiceNotifications<<BlockchainProvider<N> as ForkChoiceSubscriptions>::Header>
fn subscribe_safe_block( &self, ) -> ForkChoiceNotifications<<BlockchainProvider<N> as ForkChoiceSubscriptions>::Header>
§fn subscribe_finalized_block(
&self,
) -> ForkChoiceNotifications<<BlockchainProvider<N> as ForkChoiceSubscriptions>::Header>
fn subscribe_finalized_block( &self, ) -> ForkChoiceNotifications<<BlockchainProvider<N> as ForkChoiceSubscriptions>::Header>
§fn safe_block_stream(&self) -> ForkChoiceStream<SealedHeader<Self::Header>>
fn safe_block_stream(&self) -> ForkChoiceStream<SealedHeader<Self::Header>>
§fn finalized_block_stream(&self) -> ForkChoiceStream<SealedHeader<Self::Header>>
fn finalized_block_stream(&self) -> ForkChoiceStream<SealedHeader<Self::Header>>
§impl<N> HashedPostStateProvider for BlockchainProvider<N>where
N: NodeTypesWithDB,
impl<N> HashedPostStateProvider for BlockchainProvider<N>where
N: NodeTypesWithDB,
§fn hashed_post_state(&self, bundle_state: &BundleState) -> HashedPostState
fn hashed_post_state(&self, bundle_state: &BundleState) -> HashedPostState
HashedPostState
of the provided [BundleState
].§impl<N> HeaderProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> HeaderProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
§type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader
type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader
§fn header(
&self,
block_hash: &FixedBytes<32>,
) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
fn header( &self, block_hash: &FixedBytes<32>, ) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
§fn header_by_number(
&self,
num: u64,
) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
fn header_by_number( &self, num: u64, ) -> Result<Option<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
§fn header_td(
&self,
hash: &FixedBytes<32>,
) -> Result<Option<Uint<256, 4>>, ProviderError>
fn header_td( &self, hash: &FixedBytes<32>, ) -> Result<Option<Uint<256, 4>>, ProviderError>
§fn header_td_by_number(
&self,
number: u64,
) -> Result<Option<Uint<256, 4>>, ProviderError>
fn header_td_by_number( &self, number: u64, ) -> Result<Option<Uint<256, 4>>, ProviderError>
§fn headers_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
fn headers_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<<BlockchainProvider<N> as HeaderProvider>::Header>, ProviderError>
§fn sealed_header(
&self,
number: u64,
) -> Result<Option<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
fn sealed_header( &self, number: u64, ) -> Result<Option<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
§fn sealed_headers_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
fn sealed_headers_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
§fn sealed_headers_while(
&self,
range: impl RangeBounds<u64>,
predicate: impl FnMut(&SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>) -> bool,
) -> Result<Vec<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
fn sealed_headers_while( &self, range: impl RangeBounds<u64>, predicate: impl FnMut(&SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>) -> bool, ) -> Result<Vec<SealedHeader<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
predicate
returns true
or the range is exhausted.§fn is_known(&self, block_hash: &FixedBytes<32>) -> Result<bool, ProviderError>
fn is_known(&self, block_hash: &FixedBytes<32>) -> Result<bool, ProviderError>
§fn sealed_header_by_hash(
&self,
block_hash: FixedBytes<32>,
) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
fn sealed_header_by_hash( &self, block_hash: FixedBytes<32>, ) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
§fn header_by_hash_or_number(
&self,
hash_or_num: HashOrNumber,
) -> Result<Option<Self::Header>, ProviderError>
fn header_by_hash_or_number( &self, hash_or_num: HashOrNumber, ) -> Result<Option<Self::Header>, ProviderError>
§impl<N> NodePrimitivesProvider for BlockchainProvider<N>where
N: NodeTypesWithDB,
impl<N> NodePrimitivesProvider for BlockchainProvider<N>where
N: NodeTypesWithDB,
§type Primitives = <N as NodeTypes>::Primitives
type Primitives = <N as NodeTypes>::Primitives
§impl<N> OmmersProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> OmmersProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn ommers(
&self,
id: HashOrNumber,
) -> Result<Option<Vec<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
fn ommers( &self, id: HashOrNumber, ) -> Result<Option<Vec<<BlockchainProvider<N> as HeaderProvider>::Header>>, ProviderError>
§impl<N> PruneCheckpointReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> PruneCheckpointReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn get_prune_checkpoint(
&self,
segment: PruneSegment,
) -> Result<Option<PruneCheckpoint>, ProviderError>
fn get_prune_checkpoint( &self, segment: PruneSegment, ) -> Result<Option<PruneCheckpoint>, ProviderError>
§fn get_prune_checkpoints(
&self,
) -> Result<Vec<(PruneSegment, PruneCheckpoint)>, ProviderError>
fn get_prune_checkpoints( &self, ) -> Result<Vec<(PruneSegment, PruneCheckpoint)>, ProviderError>
§impl<N> ReceiptProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> ReceiptProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
§type Receipt = <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt
type Receipt = <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt
§fn receipt(
&self,
id: u64,
) -> Result<Option<<BlockchainProvider<N> as ReceiptProvider>::Receipt>, ProviderError>
fn receipt( &self, id: u64, ) -> Result<Option<<BlockchainProvider<N> as ReceiptProvider>::Receipt>, ProviderError>
§fn receipt_by_hash(
&self,
hash: FixedBytes<32>,
) -> Result<Option<<BlockchainProvider<N> as ReceiptProvider>::Receipt>, ProviderError>
fn receipt_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<<BlockchainProvider<N> as ReceiptProvider>::Receipt>, ProviderError>
§fn receipts_by_block(
&self,
block: HashOrNumber,
) -> Result<Option<Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>>, ProviderError>
fn receipts_by_block( &self, block: HashOrNumber, ) -> Result<Option<Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>>, ProviderError>
§fn receipts_by_tx_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>, ProviderError>
fn receipts_by_tx_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>, ProviderError>
§impl<N> ReceiptProviderIdExt for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> ReceiptProviderIdExt for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn receipts_by_block_id(
&self,
block: BlockId,
) -> Result<Option<Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>>, ProviderError>
fn receipts_by_block_id( &self, block: BlockId, ) -> Result<Option<Vec<<BlockchainProvider<N> as ReceiptProvider>::Receipt>>, ProviderError>
§fn receipts_by_number_or_tag(
&self,
number_or_tag: BlockNumberOrTag,
) -> Result<Option<Vec<Self::Receipt>>, ProviderError>
fn receipts_by_number_or_tag( &self, number_or_tag: BlockNumberOrTag, ) -> Result<Option<Vec<Self::Receipt>>, ProviderError>
BlockId
from the database. Read more§impl<N> StageCheckpointReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> StageCheckpointReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn get_stage_checkpoint(
&self,
id: StageId,
) -> Result<Option<StageCheckpoint>, ProviderError>
fn get_stage_checkpoint( &self, id: StageId, ) -> Result<Option<StageCheckpoint>, ProviderError>
§fn get_stage_checkpoint_progress(
&self,
id: StageId,
) -> Result<Option<Vec<u8>>, ProviderError>
fn get_stage_checkpoint_progress( &self, id: StageId, ) -> Result<Option<Vec<u8>>, ProviderError>
§fn get_all_checkpoints(
&self,
) -> Result<Vec<(String, StageCheckpoint)>, ProviderError>
fn get_all_checkpoints( &self, ) -> Result<Vec<(String, StageCheckpoint)>, ProviderError>
§impl<N> StateCommitmentProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> StateCommitmentProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
§type StateCommitment = <N as NodeTypes>::StateCommitment
type StateCommitment = <N as NodeTypes>::StateCommitment
reth_trie_db::StateCommitment
] type that can be used to perform state commitment
operations.§impl<N> StateProviderFactory for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> StateProviderFactory for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn latest(&self) -> Result<Box<dyn StateProvider>, ProviderError>
fn latest(&self) -> Result<Box<dyn StateProvider>, ProviderError>
Storage provider for latest block
§fn pending(&self) -> Result<Box<dyn StateProvider>, ProviderError>
fn pending(&self) -> Result<Box<dyn StateProvider>, ProviderError>
Returns the state provider for pending state.
If there’s no pending block available then the latest state provider is returned:
Self::latest
§fn state_by_block_number_or_tag(
&self,
number_or_tag: BlockNumberOrTag,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn state_by_block_number_or_tag( &self, number_or_tag: BlockNumberOrTag, ) -> Result<Box<dyn StateProvider>, ProviderError>
Returns a StateProviderBox
indexed by the given block number or tag.
§fn history_by_block_number(
&self,
block_number: u64,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn history_by_block_number( &self, block_number: u64, ) -> Result<Box<dyn StateProvider>, ProviderError>
§fn history_by_block_hash(
&self,
block_hash: FixedBytes<32>,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn history_by_block_hash( &self, block_hash: FixedBytes<32>, ) -> Result<Box<dyn StateProvider>, ProviderError>
§fn state_by_block_hash(
&self,
hash: FixedBytes<32>,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn state_by_block_hash( &self, hash: FixedBytes<32>, ) -> Result<Box<dyn StateProvider>, ProviderError>
§fn pending_state_by_hash(
&self,
block_hash: FixedBytes<32>,
) -> Result<Option<Box<dyn StateProvider>>, ProviderError>
fn pending_state_by_hash( &self, block_hash: FixedBytes<32>, ) -> Result<Option<Box<dyn StateProvider>>, ProviderError>
§fn state_by_block_id(
&self,
block_id: BlockId,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn state_by_block_id( &self, block_id: BlockId, ) -> Result<Box<dyn StateProvider>, ProviderError>
§impl<N> StateReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> StateReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn get_state(
&self,
block: u64,
) -> Result<Option<ExecutionOutcome<<BlockchainProvider<N> as StateReader>::Receipt>>, ProviderError>
fn get_state( &self, block: u64, ) -> Result<Option<ExecutionOutcome<<BlockchainProvider<N> as StateReader>::Receipt>>, ProviderError>
Re-constructs the ExecutionOutcome
from in-memory and database state, if necessary.
If data for the block does not exist, this will return None
.
NOTE: This cannot be called safely in a loop outside of the blockchain tree thread. This is
because the [CanonicalInMemoryState
] could change during a reorg, causing results to be
inconsistent. Currently this can safely be called within the blockchain tree thread,
because the tree thread is responsible for modifying the [CanonicalInMemoryState
] in the
first place.
§type Receipt = <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt
type Receipt = <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt
ExecutionOutcome
.§impl<N> StaticFileProviderFactory for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> StaticFileProviderFactory for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn static_file_provider(
&self,
) -> StaticFileProvider<<BlockchainProvider<N> as NodePrimitivesProvider>::Primitives>
fn static_file_provider( &self, ) -> StaticFileProvider<<BlockchainProvider<N> as NodePrimitivesProvider>::Primitives>
§impl<N> StorageChangeSetReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> StorageChangeSetReader for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn storage_changeset(
&self,
block_number: u64,
) -> Result<Vec<(BlockNumberAddress, StorageEntry)>, ProviderError>
fn storage_changeset( &self, block_number: u64, ) -> Result<Vec<(BlockNumberAddress, StorageEntry)>, ProviderError>
§impl<N> TransactionsProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> TransactionsProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
§type Transaction = <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx
type Transaction = <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx
§fn transaction_id(
&self,
tx_hash: FixedBytes<32>,
) -> Result<Option<u64>, ProviderError>
fn transaction_id( &self, tx_hash: FixedBytes<32>, ) -> Result<Option<u64>, ProviderError>
§fn transaction_by_id(
&self,
id: u64,
) -> Result<Option<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
fn transaction_by_id( &self, id: u64, ) -> Result<Option<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
§fn transaction_by_id_unhashed(
&self,
id: u64,
) -> Result<Option<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
fn transaction_by_id_unhashed( &self, id: u64, ) -> Result<Option<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
§fn transaction_by_hash(
&self,
hash: FixedBytes<32>,
) -> Result<Option<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
fn transaction_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
§fn transaction_by_hash_with_meta(
&self,
tx_hash: FixedBytes<32>,
) -> Result<Option<(<BlockchainProvider<N> as TransactionsProvider>::Transaction, TransactionMeta)>, ProviderError>
fn transaction_by_hash_with_meta( &self, tx_hash: FixedBytes<32>, ) -> Result<Option<(<BlockchainProvider<N> as TransactionsProvider>::Transaction, TransactionMeta)>, ProviderError>
§fn transaction_block(&self, id: u64) -> Result<Option<u64>, ProviderError>
fn transaction_block(&self, id: u64) -> Result<Option<u64>, ProviderError>
§fn transactions_by_block(
&self,
id: HashOrNumber,
) -> Result<Option<Vec<<BlockchainProvider<N> as TransactionsProvider>::Transaction>>, ProviderError>
fn transactions_by_block( &self, id: HashOrNumber, ) -> Result<Option<Vec<<BlockchainProvider<N> as TransactionsProvider>::Transaction>>, ProviderError>
§fn transactions_by_block_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<Vec<<BlockchainProvider<N> as TransactionsProvider>::Transaction>>, ProviderError>
fn transactions_by_block_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<Vec<<BlockchainProvider<N> as TransactionsProvider>::Transaction>>, ProviderError>
§fn transactions_by_tx_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
fn transactions_by_tx_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<<BlockchainProvider<N> as TransactionsProvider>::Transaction>, ProviderError>
§fn senders_by_tx_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<Address>, ProviderError>
fn senders_by_tx_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<Address>, ProviderError>
§fn transaction_sender(&self, id: u64) -> Result<Option<Address>, ProviderError>
fn transaction_sender(&self, id: u64) -> Result<Option<Address>, ProviderError>
§impl<N> WithdrawalsProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
impl<N> WithdrawalsProvider for BlockchainProvider<N>where
N: ProviderNodeTypes,
§fn withdrawals_by_block(
&self,
id: HashOrNumber,
timestamp: u64,
) -> Result<Option<Withdrawals>, ProviderError>
fn withdrawals_by_block( &self, id: HashOrNumber, timestamp: u64, ) -> Result<Option<Withdrawals>, ProviderError>
Auto Trait Implementations§
impl<N> Freeze for BlockchainProvider<N>
impl<N> !RefUnwindSafe for BlockchainProvider<N>
impl<N> Send for BlockchainProvider<N>
impl<N> Sync for BlockchainProvider<N>
impl<N> Unpin for BlockchainProvider<N>
impl<N> !UnwindSafe for BlockchainProvider<N>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
§fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
TxEnv
from a transaction and a sender address.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
Source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<N, T> BlockReaderFor<N> for Twhere
N: NetworkPrimitives,
T: BlockReader<Block = <N as NetworkPrimitives>::Block, Header = <N as NetworkPrimitives>::BlockHeader, Transaction = <<N as NetworkPrimitives>::BlockBody as BlockBody>::Transaction, Receipt = <N as NetworkPrimitives>::Receipt>,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T, N> FullProvider<N> for Twhere
T: BlockReaderIdExt<Transaction = <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx, Block = <<N as NodeTypes>::Primitives as NodePrimitives>::Block, Receipt = <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt, Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader> + DatabaseProviderFactory<DB = <N as NodeTypesWithDB>::DB> + NodePrimitivesProvider<Primitives = <N as NodeTypes>::Primitives, Primitives = <N as NodeTypes>::Primitives> + AccountReader + StateProviderFactory + ChainSpecProvider<ChainSpec = <N as NodeTypes>::ChainSpec> + StaticFileProviderFactory + ChangeSetReader + CanonStateSubscriptions + ForkChoiceSubscriptions<Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader> + StageCheckpointReader + Clone + Unpin + 'static,
N: NodeTypesWithDB,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
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.