Struct MockEthProvider
pub struct MockEthProvider<T = TransactionSigned, ChainSpec = ChainSpec> {
pub blocks: Arc<Mutex<RawMutex, HashMap<FixedBytes<32>, Block<T>, RandomState>>>,
pub headers: Arc<Mutex<RawMutex, HashMap<FixedBytes<32>, Header, RandomState>>>,
pub accounts: Arc<Mutex<RawMutex, HashMap<Address, ExtendedAccount, RandomState>>>,
pub chain_spec: Arc<ChainSpec>,
pub state_roots: Arc<Mutex<RawMutex, Vec<FixedBytes<32>>>>,
}
test-utils
only.Expand description
A mock implementation for Provider interfaces.
Fields§
§blocks: Arc<Mutex<RawMutex, HashMap<FixedBytes<32>, Block<T>, RandomState>>>
Local block store
headers: Arc<Mutex<RawMutex, HashMap<FixedBytes<32>, Header, RandomState>>>
Local header store
accounts: Arc<Mutex<RawMutex, HashMap<Address, ExtendedAccount, RandomState>>>
Local account store
chain_spec: Arc<ChainSpec>
Local chain spec
state_roots: Arc<Mutex<RawMutex, Vec<FixedBytes<32>>>>
Local state roots
Implementations§
§impl<T> MockEthProvider<T>
impl<T> MockEthProvider<T>
pub fn new() -> MockEthProvider<T>
pub fn new() -> MockEthProvider<T>
Create a new, empty instance
§impl<T, ChainSpec> MockEthProvider<T, ChainSpec>
impl<T, ChainSpec> MockEthProvider<T, ChainSpec>
pub fn add_block(&self, hash: FixedBytes<32>, block: Block<T>)
pub fn add_block(&self, hash: FixedBytes<32>, block: Block<T>)
Add block to local block store
pub fn extend_blocks(
&self,
iter: impl IntoIterator<Item = (FixedBytes<32>, Block<T>)>,
)
pub fn extend_blocks( &self, iter: impl IntoIterator<Item = (FixedBytes<32>, Block<T>)>, )
Add multiple blocks to local block store
pub fn add_header(&self, hash: FixedBytes<32>, header: Header)
pub fn add_header(&self, hash: FixedBytes<32>, header: Header)
Add header to local header store
pub fn extend_headers(
&self,
iter: impl IntoIterator<Item = (FixedBytes<32>, Header)>,
)
pub fn extend_headers( &self, iter: impl IntoIterator<Item = (FixedBytes<32>, Header)>, )
Add multiple headers to local header store
pub fn add_account(&self, address: Address, account: ExtendedAccount)
pub fn add_account(&self, address: Address, account: ExtendedAccount)
Add account to local account store
pub fn extend_accounts(
&self,
iter: impl IntoIterator<Item = (Address, ExtendedAccount)>,
)
pub fn extend_accounts( &self, iter: impl IntoIterator<Item = (Address, ExtendedAccount)>, )
Add account to local account store
pub fn add_state_root(&self, state_root: FixedBytes<32>)
pub fn add_state_root(&self, state_root: FixedBytes<32>)
Add state root to local state root store
pub fn with_chain_spec<C>(self, chain_spec: C) -> MockEthProvider<T, C>
pub fn with_chain_spec<C>(self, chain_spec: C) -> MockEthProvider<T, C>
Set chain spec.
Trait Implementations§
§impl<T, ChainSpec> AccountReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> AccountReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn basic_account(
&self,
address: &Address,
) -> Result<Option<Account>, ProviderError>
fn basic_account( &self, address: &Address, ) -> Result<Option<Account>, ProviderError>
§impl<T, ChainSpec> BlockBodyIndicesProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> BlockBodyIndicesProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn block_body_indices(
&self,
_num: u64,
) -> Result<Option<StoredBlockBodyIndices>, ProviderError>
fn block_body_indices( &self, _num: 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<T, ChainSpec> BlockHashReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> BlockHashReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§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<T, ChainSpec> BlockIdReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> BlockIdReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§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<T, ChainSpec> BlockNumReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> BlockNumReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§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<T, ChainSpec> BlockReader for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> BlockReader for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec,
§fn find_block_by_hash(
&self,
hash: FixedBytes<32>,
_source: BlockSource,
) -> Result<Option<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, ProviderError>
fn find_block_by_hash( &self, hash: FixedBytes<32>, _source: BlockSource, ) -> Result<Option<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, ProviderError>
§fn block(
&self,
id: HashOrNumber,
) -> Result<Option<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, ProviderError>
fn block( &self, id: HashOrNumber, ) -> Result<Option<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, ProviderError>
§fn pending_block(
&self,
) -> Result<Option<SealedBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
fn pending_block( &self, ) -> Result<Option<SealedBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
§fn pending_block_with_senders(
&self,
) -> Result<Option<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
fn pending_block_with_senders( &self, ) -> Result<Option<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
§fn pending_block_and_receipts(
&self,
) -> Result<Option<(SealedBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, Vec<Receipt>)>, ProviderError>
fn pending_block_and_receipts( &self, ) -> Result<Option<(SealedBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, Vec<Receipt>)>, ProviderError>
§fn block_with_senders(
&self,
_id: HashOrNumber,
_transaction_kind: TransactionVariant,
) -> Result<Option<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
fn block_with_senders( &self, _id: HashOrNumber, _transaction_kind: TransactionVariant, ) -> Result<Option<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
§fn sealed_block_with_senders(
&self,
_id: HashOrNumber,
_transaction_kind: TransactionVariant,
) -> Result<Option<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
fn sealed_block_with_senders( &self, _id: HashOrNumber, _transaction_kind: TransactionVariant, ) -> Result<Option<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
§fn block_range(
&self,
range: RangeInclusive<u64>,
) -> Result<Vec<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, ProviderError>
fn block_range( &self, range: RangeInclusive<u64>, ) -> Result<Vec<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>, ProviderError>
§fn block_with_senders_range(
&self,
_range: RangeInclusive<u64>,
) -> Result<Vec<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
fn block_with_senders_range( &self, _range: RangeInclusive<u64>, ) -> Result<Vec<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
§fn sealed_block_with_senders_range(
&self,
_range: RangeInclusive<u64>,
) -> Result<Vec<RecoveredBlock<<MockEthProvider<T, ChainSpec> as BlockReader>::Block>>, ProviderError>
fn sealed_block_with_senders_range( &self, _range: RangeInclusive<u64>, ) -> Result<Vec<RecoveredBlock<<MockEthProvider<T, ChainSpec> 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<T, ChainSpec> BlockReaderIdExt for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> BlockReaderIdExt for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec,
§fn block_by_id(&self, id: BlockId) -> Result<Option<Block<T>>, ProviderError>
fn block_by_id(&self, id: BlockId) -> Result<Option<Block<T>>, ProviderError>
§fn sealed_header_by_id(
&self,
id: BlockId,
) -> Result<Option<SealedHeader>, ProviderError>
fn sealed_header_by_id( &self, id: BlockId, ) -> Result<Option<SealedHeader>, ProviderError>
BlockId
from the database. Read more§fn header_by_id(&self, id: BlockId) -> Result<Option<Header>, ProviderError>
fn header_by_id(&self, id: BlockId) -> Result<Option<Header>, ProviderError>
BlockId
from the database. Read more§fn ommers_by_id(
&self,
id: BlockId,
) -> Result<Option<Vec<Header>>, ProviderError>
fn ommers_by_id( &self, id: BlockId, ) -> Result<Option<Vec<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 header_by_number_or_tag(
&self,
id: BlockNumberOrTag,
) -> Result<Option<Self::Header>, ProviderError>
fn header_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<Self::Header>, ProviderError>
§fn sealed_header_by_number_or_tag(
&self,
id: BlockNumberOrTag,
) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>
fn sealed_header_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<SealedHeader<Self::Header>>, 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<T, ChainSpec> ChainSpecProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec + 'static,
impl<T, ChainSpec> ChainSpecProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec + 'static,
§impl<T, ChainSpec> ChangeSetReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> ChangeSetReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§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<T, ChainSpec> Clone for MockEthProvider<T, ChainSpec>
impl<T, ChainSpec> Clone for MockEthProvider<T, ChainSpec>
§fn clone(&self) -> MockEthProvider<T, ChainSpec>
fn clone(&self) -> MockEthProvider<T, ChainSpec>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<T, ChainSpec> DatabaseProviderFactory for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> DatabaseProviderFactory for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§type Provider = DatabaseProvider<TxMock, MockNode>
type Provider = DatabaseProvider<TxMock, MockNode>
§type ProviderRW = DatabaseProvider<TxMock, MockNode>
type ProviderRW = DatabaseProvider<TxMock, MockNode>
§fn database_provider_ro(
&self,
) -> Result<<MockEthProvider<T, ChainSpec> as DatabaseProviderFactory>::Provider, ProviderError>
fn database_provider_ro( &self, ) -> Result<<MockEthProvider<T, ChainSpec> as DatabaseProviderFactory>::Provider, ProviderError>
§fn database_provider_rw(
&self,
) -> Result<<MockEthProvider<T, ChainSpec> as DatabaseProviderFactory>::ProviderRW, ProviderError>
fn database_provider_rw( &self, ) -> Result<<MockEthProvider<T, ChainSpec> as DatabaseProviderFactory>::ProviderRW, ProviderError>
§impl<T, ChainSpec> Debug for MockEthProvider<T, ChainSpec>
impl<T, ChainSpec> Debug for MockEthProvider<T, ChainSpec>
§impl Default for MockEthProvider
impl Default for MockEthProvider
§fn default() -> MockEthProvider
fn default() -> MockEthProvider
§impl<T, ChainSpec> HashedPostStateProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec + 'static,
impl<T, ChainSpec> HashedPostStateProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec + 'static,
§fn hashed_post_state(&self, _state: &BundleState) -> HashedPostState
fn hashed_post_state(&self, _state: &BundleState) -> HashedPostState
HashedPostState
of the provided BundleState
.§impl<T, ChainSpec> HeaderProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> HeaderProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn header(
&self,
block_hash: &FixedBytes<32>,
) -> Result<Option<Header>, ProviderError>
fn header( &self, block_hash: &FixedBytes<32>, ) -> Result<Option<Header>, ProviderError>
§fn header_by_number(&self, num: u64) -> Result<Option<Header>, ProviderError>
fn header_by_number(&self, num: u64) -> Result<Option<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<Header>, ProviderError>
fn headers_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<Header>, ProviderError>
§fn sealed_header(
&self,
number: u64,
) -> Result<Option<SealedHeader>, ProviderError>
fn sealed_header( &self, number: u64, ) -> Result<Option<SealedHeader>, ProviderError>
§fn sealed_headers_while(
&self,
range: impl RangeBounds<u64>,
predicate: impl FnMut(&SealedHeader) -> bool,
) -> Result<Vec<SealedHeader>, ProviderError>
fn sealed_headers_while( &self, range: impl RangeBounds<u64>, predicate: impl FnMut(&SealedHeader) -> bool, ) -> Result<Vec<SealedHeader>, 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>
§fn sealed_headers_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<SealedHeader<Self::Header>>, ProviderError>
fn sealed_headers_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<SealedHeader<Self::Header>>, ProviderError>
§impl<T, ChainSpec> OmmersProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> OmmersProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn ommers(
&self,
_id: HashOrNumber,
) -> Result<Option<Vec<Header>>, ProviderError>
fn ommers( &self, _id: HashOrNumber, ) -> Result<Option<Vec<Header>>, ProviderError>
§impl<T, ChainSpec> ReceiptProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> ReceiptProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn receipt(&self, _id: u64) -> Result<Option<Receipt>, ProviderError>
fn receipt(&self, _id: u64) -> Result<Option<Receipt>, ProviderError>
§fn receipt_by_hash(
&self,
_hash: FixedBytes<32>,
) -> Result<Option<Receipt>, ProviderError>
fn receipt_by_hash( &self, _hash: FixedBytes<32>, ) -> Result<Option<Receipt>, ProviderError>
§fn receipts_by_block(
&self,
_block: HashOrNumber,
) -> Result<Option<Vec<Receipt>>, ProviderError>
fn receipts_by_block( &self, _block: HashOrNumber, ) -> Result<Option<Vec<Receipt>>, ProviderError>
§fn receipts_by_tx_range(
&self,
_range: impl RangeBounds<u64>,
) -> Result<Vec<Receipt>, ProviderError>
fn receipts_by_tx_range( &self, _range: impl RangeBounds<u64>, ) -> Result<Vec<Receipt>, ProviderError>
§impl<T, ChainSpec> ReceiptProviderIdExt for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> ReceiptProviderIdExt for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn receipts_by_block_id(
&self,
block: BlockId,
) -> Result<Option<Vec<Self::Receipt>>, ProviderError>
fn receipts_by_block_id( &self, block: BlockId, ) -> Result<Option<Vec<Self::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<T, ChainSpec> StageCheckpointReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> StageCheckpointReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§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<T, ChainSpec> StateCommitmentProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> StateCommitmentProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§type StateCommitment = <MockNode as NodeTypes>::StateCommitment
type StateCommitment = <MockNode as NodeTypes>::StateCommitment
StateCommitment
] type that can be used to perform state commitment operations.§impl<T, ChainSpec> StateProofProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> StateProofProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn proof(
&self,
_input: TrieInput,
address: Address,
_slots: &[FixedBytes<32>],
) -> Result<AccountProof, ProviderError>
fn proof( &self, _input: TrieInput, address: Address, _slots: &[FixedBytes<32>], ) -> Result<AccountProof, ProviderError>
HashedPostState
on top of the current state.§fn multiproof(
&self,
_input: TrieInput,
_targets: HashMap<FixedBytes<32>, HashSet<FixedBytes<32>, FbBuildHasher<32>>, FbBuildHasher<32>>,
) -> Result<MultiProof, ProviderError>
fn multiproof( &self, _input: TrieInput, _targets: HashMap<FixedBytes<32>, HashSet<FixedBytes<32>, FbBuildHasher<32>>, FbBuildHasher<32>>, ) -> Result<MultiProof, ProviderError>
MultiProof
] for target hashed account and corresponding
hashed storage slot keys.§fn witness(
&self,
_input: TrieInput,
_target: HashedPostState,
) -> Result<HashMap<FixedBytes<32>, Bytes, FbBuildHasher<32>>, ProviderError>
fn witness( &self, _input: TrieInput, _target: HashedPostState, ) -> Result<HashMap<FixedBytes<32>, Bytes, FbBuildHasher<32>>, ProviderError>
§impl<T, ChainSpec> StateProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec + 'static,
impl<T, ChainSpec> StateProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec + 'static,
§fn storage(
&self,
account: Address,
storage_key: FixedBytes<32>,
) -> Result<Option<Uint<256, 4>>, ProviderError>
fn storage( &self, account: Address, storage_key: FixedBytes<32>, ) -> Result<Option<Uint<256, 4>>, ProviderError>
§fn bytecode_by_hash(
&self,
code_hash: &FixedBytes<32>,
) -> Result<Option<Bytecode>, ProviderError>
fn bytecode_by_hash( &self, code_hash: &FixedBytes<32>, ) -> Result<Option<Bytecode>, ProviderError>
§fn account_code(
&self,
addr: &Address,
) -> Result<Option<Bytecode>, ProviderError>
fn account_code( &self, addr: &Address, ) -> Result<Option<Bytecode>, ProviderError>
§fn account_balance(
&self,
addr: &Address,
) -> Result<Option<Uint<256, 4>>, ProviderError>
fn account_balance( &self, addr: &Address, ) -> Result<Option<Uint<256, 4>>, ProviderError>
§fn account_nonce(&self, addr: &Address) -> Result<Option<u64>, ProviderError>
fn account_nonce(&self, addr: &Address) -> Result<Option<u64>, ProviderError>
§impl<T, ChainSpec> StateProviderFactory for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec + 'static,
impl<T, ChainSpec> StateProviderFactory for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec + 'static,
§fn latest(&self) -> Result<Box<dyn StateProvider>, ProviderError>
fn latest(&self) -> Result<Box<dyn StateProvider>, ProviderError>
§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>
§fn history_by_block_number(
&self,
_block: u64,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn history_by_block_number( &self, _block: u64, ) -> Result<Box<dyn StateProvider>, ProviderError>
§fn history_by_block_hash(
&self,
_block: FixedBytes<32>,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn history_by_block_hash( &self, _block: FixedBytes<32>, ) -> Result<Box<dyn StateProvider>, ProviderError>
§fn state_by_block_hash(
&self,
_block: FixedBytes<32>,
) -> Result<Box<dyn StateProvider>, ProviderError>
fn state_by_block_hash( &self, _block: FixedBytes<32>, ) -> Result<Box<dyn StateProvider>, ProviderError>
§fn pending(&self) -> Result<Box<dyn StateProvider>, ProviderError>
fn pending(&self) -> 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<T, ChainSpec> StateReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> StateReader for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§type Receipt = Receipt
type Receipt = Receipt
ExecutionOutcome
.§fn get_state(
&self,
_block: u64,
) -> Result<Option<ExecutionOutcome>, ProviderError>
fn get_state( &self, _block: u64, ) -> Result<Option<ExecutionOutcome>, ProviderError>
ExecutionOutcome
for the given block§impl<T, ChainSpec> StateRootProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> StateRootProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn state_root(
&self,
_state: HashedPostState,
) -> Result<FixedBytes<32>, ProviderError>
fn state_root( &self, _state: HashedPostState, ) -> Result<FixedBytes<32>, ProviderError>
BundleState
on top of the current state. Read more§fn state_root_from_nodes(
&self,
_input: TrieInput,
) -> Result<FixedBytes<32>, ProviderError>
fn state_root_from_nodes( &self, _input: TrieInput, ) -> Result<FixedBytes<32>, ProviderError>
HashedPostState
on top of the current state but reuses the
intermediate nodes to speed up the computation. It’s up to the caller to construct the
prefix sets and inform the provider of the trie paths that have changes.§fn state_root_with_updates(
&self,
_state: HashedPostState,
) -> Result<(FixedBytes<32>, TrieUpdates), ProviderError>
fn state_root_with_updates( &self, _state: HashedPostState, ) -> Result<(FixedBytes<32>, TrieUpdates), ProviderError>
HashedPostState
on top of the current state with trie
updates to be committed to the database.§fn state_root_from_nodes_with_updates(
&self,
_input: TrieInput,
) -> Result<(FixedBytes<32>, TrieUpdates), ProviderError>
fn state_root_from_nodes_with_updates( &self, _input: TrieInput, ) -> Result<(FixedBytes<32>, TrieUpdates), ProviderError>
StateRootProvider::state_root_from_nodes
for more info.§impl<T, ChainSpec> StorageRootProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> StorageRootProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§fn storage_root(
&self,
_address: Address,
_hashed_storage: HashedStorage,
) -> Result<FixedBytes<32>, ProviderError>
fn storage_root( &self, _address: Address, _hashed_storage: HashedStorage, ) -> Result<FixedBytes<32>, ProviderError>
HashedStorage
for target address on top of the current
state.§fn storage_proof(
&self,
_address: Address,
slot: FixedBytes<32>,
_hashed_storage: HashedStorage,
) -> Result<StorageProof, ProviderError>
fn storage_proof( &self, _address: Address, slot: FixedBytes<32>, _hashed_storage: HashedStorage, ) -> Result<StorageProof, ProviderError>
HashedStorage
for target slot on top of the current
state.§fn storage_multiproof(
&self,
_address: Address,
_slots: &[FixedBytes<32>],
_hashed_storage: HashedStorage,
) -> Result<StorageMultiProof, ProviderError>
fn storage_multiproof( &self, _address: Address, _slots: &[FixedBytes<32>], _hashed_storage: HashedStorage, ) -> Result<StorageMultiProof, ProviderError>
§impl<T, ChainSpec> TransactionsProvider for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> TransactionsProvider for MockEthProvider<T, ChainSpec>where
T: SignedTransaction,
ChainSpec: EthChainSpec,
§type Transaction = T
type Transaction = T
§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<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>, ProviderError>
fn transaction_by_id( &self, id: u64, ) -> Result<Option<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>, ProviderError>
§fn transaction_by_id_unhashed(
&self,
id: u64,
) -> Result<Option<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>, ProviderError>
fn transaction_by_id_unhashed( &self, id: u64, ) -> Result<Option<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>, ProviderError>
§fn transaction_by_hash(
&self,
hash: FixedBytes<32>,
) -> Result<Option<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>, ProviderError>
fn transaction_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>, ProviderError>
§fn transaction_by_hash_with_meta(
&self,
hash: FixedBytes<32>,
) -> Result<Option<(<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction, TransactionMeta)>, ProviderError>
fn transaction_by_hash_with_meta( &self, hash: FixedBytes<32>, ) -> Result<Option<(<MockEthProvider<T, ChainSpec> 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<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>>, ProviderError>
fn transactions_by_block( &self, id: HashOrNumber, ) -> Result<Option<Vec<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>>, ProviderError>
§fn transactions_by_block_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<Vec<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>>, ProviderError>
fn transactions_by_block_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<Vec<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>>, ProviderError>
§fn transactions_by_tx_range(
&self,
range: impl RangeBounds<u64>,
) -> Result<Vec<<MockEthProvider<T, ChainSpec> as TransactionsProvider>::Transaction>, ProviderError>
fn transactions_by_tx_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<<MockEthProvider<T, ChainSpec> 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<T, ChainSpec> WithdrawalsProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
impl<T, ChainSpec> WithdrawalsProvider for MockEthProvider<T, ChainSpec>where
T: Transaction,
ChainSpec: EthChainSpec,
§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<T, ChainSpec> Freeze for MockEthProvider<T, ChainSpec>
impl<T = TransactionSigned, ChainSpec = ChainSpec> !RefUnwindSafe for MockEthProvider<T, ChainSpec>
impl<T, ChainSpec> Send for MockEthProvider<T, ChainSpec>
impl<T, ChainSpec> Sync for MockEthProvider<T, ChainSpec>
impl<T, ChainSpec> Unpin for MockEthProvider<T, ChainSpec>
impl<T = TransactionSigned, ChainSpec = ChainSpec> !UnwindSafe for MockEthProvider<T, ChainSpec>
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> EvmStateProvider for Twhere
T: StateProvider,
impl<T> EvmStateProvider for Twhere
T: StateProvider,
§fn basic_account(
&self,
address: &Address,
) -> Result<Option<Account>, ProviderError>
fn basic_account( &self, address: &Address, ) -> Result<Option<Account>, ProviderError>
§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 bytecode_by_hash(
&self,
code_hash: &FixedBytes<32>,
) -> Result<Option<Bytecode>, ProviderError>
fn bytecode_by_hash( &self, code_hash: &FixedBytes<32>, ) -> Result<Option<Bytecode>, ProviderError>
§fn storage(
&self,
account: Address,
storage_key: FixedBytes<32>,
) -> Result<Option<Uint<256, 4>>, ProviderError>
fn storage( &self, account: Address, storage_key: FixedBytes<32>, ) -> Result<Option<Uint<256, 4>>, ProviderError>
§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<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> 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<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
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: 40 bytes