pub struct Backend<FEN = EthEvmNetwork>where
FEN: FoundryEvmNetwork,{
networks: NetworkConfigs,
forks: MultiFork,
lifecycle: ExecutionLifecycle<<FEN as FoundryEvmNetwork>::EvmFactory>,
cheatcode_access: HashSet<Address, FbBuildHasher<20>>,
caller: Option<Address>,
has_state_snapshot_failure: bool,
fork_block_number_override: Option<u64>,
bal: Option<(Arc<Bal>, BlockAccessIndex)>,
}Expand description
Foundry’s executor backend.
See the module documentation for the execution contract. Cloning a backend clones the accepted state of every context without copying it (contexts share their caches copy-on-write), which parallel fuzzing relies on.
Fields§
§networks: NetworkConfigs§forks: MultiFork§lifecycle: ExecutionLifecycle<<FEN as FoundryEvmNetwork>::EvmFactory>§cheatcode_access: HashSet<Address, FbBuildHasher<20>>§caller: Option<Address>§has_state_snapshot_failure: bool§fork_block_number_override: Option<u64>§bal: Option<(Arc<Bal>, BlockAccessIndex)>Implementations§
Source§impl<FEN> Backend<FEN>where
FEN: FoundryEvmNetwork,
impl<FEN> Backend<FEN>where
FEN: FoundryEvmNetwork,
Sourcepub fn set_bal(&mut self, bal: Arc<Bal>, index: BlockAccessIndex)
pub fn set_bal(&mut self, bal: Arc<Bal>, index: BlockAccessIndex)
Serves reads of state the block wrote before index from bal, and everything else from
the underlying database.
Index 0 holds the pre-block system writes and transaction i is index i + 1, so
positioning the reads at a transaction’s own index yields its prestate without replaying
the earlier transactions. The list applies to EVMs created afterwards; parking an EVM
removes it again, so the backend must not execute further transactions of that block
afterwards.
Source§impl<FEN> Backend<FEN>where
FEN: FoundryEvmNetwork,
impl<FEN> Backend<FEN>where
FEN: FoundryEvmNetwork,
Sourcepub fn spawn(
fork: Option<CreateFork>,
env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<Backend<FEN>, Report>
pub fn spawn( fork: Option<CreateFork>, env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<Backend<FEN>, Report>
Creates a backend with a spawned fork manager.
If fork is Some, execution starts on that fork with environment env, otherwise on an
empty local database.
Sourcepub fn spawn_fork(
fork: CreateFork,
configure_env: impl FnOnce(&mut EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ExecutionSpecContext),
) -> Result<Backend<FEN>, Report>
pub fn spawn_fork( fork: CreateFork, configure_env: impl FnOnce(&mut EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ExecutionSpecContext), ) -> Result<Backend<FEN>, Report>
Resolves the fork once, configuring its environment before initializing network state.
Sourcepub fn spawn_source(
fork: Option<CreateFork>,
local_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<Backend<FEN>, Report>
pub fn spawn_source( fork: Option<CreateFork>, local_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<Backend<FEN>, Report>
Creates a backend that starts on fork at its resolved block’s environment, or locally
with local_env.
Sourcepub fn new(
forks: MultiFork,
fork: Option<CreateFork>,
env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<Backend<FEN>, Report>
pub fn new( forks: MultiFork, fork: Option<CreateFork>, env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<Backend<FEN>, Report>
Creates a backend that uses forks for remote fork caches.
If fork is Some, execution starts on that fork with environment env exactly, otherwise
on an empty local database. Prefer Self::spawn.
Sourcepub fn with_db(
db: impl BackingDb,
env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Backend<FEN>
pub fn with_db( db: impl BackingDb, env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Backend<FEN>
Creates a backend executing locally over db, such as an in-memory database.
Sourcepub fn clone_with_fork_scope(&self) -> Result<Backend<FEN>, Report>
pub fn clone_with_fork_scope(&self) -> Result<Backend<FEN>, Report>
Clones execution state with an independent registry for newly created forks.
Remote caches remain shared, but forks created by this execution are released with it.
Sourcepub fn clone_empty(&self) -> Backend<FEN>
pub fn clone_empty(&self) -> Backend<FEN>
Creates an empty local backend sharing this backend’s fork manager and environment.
Sourcepub fn clone_empty_with_env(
&self,
env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Backend<FEN>
pub fn clone_empty_with_env( &self, env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Backend<FEN>
Creates an empty local backend sharing this backend’s fork manager, with network state
seeded at env.
Network state can depend on the hardfork, such as Tempo’s genesis, so a test contract pinned to another hardfork needs its own seed.
Sourcepub fn replace_fork(
&mut self,
fork: Option<CreateFork>,
local_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<(), Report>
pub fn replace_fork( &mut self, fork: Option<CreateFork>, local_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<(), Report>
Replaces this backend with one starting on fork at its resolved block’s environment, or
locally with local_env, reusing the fork manager’s remote caches.
Sourcepub fn fork(&self) -> Option<Fork>
pub fn fork(&self) -> Option<Fork>
Returns the remote fork of the active context, if execution is forked over RPC.
Sourcepub async fn env(
&self,
opts: &EvmOpts,
) -> Result<(EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest), Report>
pub async fn env( &self, opts: &EvmOpts, ) -> Result<(EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest), Report>
Builds execution environments from this backend’s selected remote block.
Sourcepub async fn can_use_create2_deployer(
&self,
deployer: Address,
) -> Result<bool, Report>
pub async fn can_use_create2_deployer( &self, deployer: Address, ) -> Result<bool, Report>
Checks library-linking availability against this backend’s remote state.
Sourcepub async fn transaction_count(&self, sender: Address) -> Result<u64, Report>
pub async fn transaction_count(&self, sender: Address) -> Result<u64, Report>
Reads a sender nonce at this backend’s remote block before local execution.
Sourcepub const fn networks(&self) -> NetworkConfigs
pub const fn networks(&self) -> NetworkConfigs
Returns the active network configuration.
Sourcepub fn set_networks(&mut self, networks: NetworkConfigs)
pub fn set_networks(&mut self, networks: NetworkConfigs)
Sets the active network configuration.
Sourcepub const fn set_fork_block_number_override(&mut self, block_number: u64)
pub const fn set_fork_block_number_override(&mut self, block_number: u64)
Sets the block number the active fork reports while executing transactions of that block on top of its parent’s state.
Sourcepub const fn factory(&self) -> &<FEN as FoundryEvmNetwork>::EvmFactory
pub const fn factory(&self) -> &<FEN as FoundryEvmNetwork>::EvmFactory
Returns the EVM factory.
Sourcepub const fn lifecycle(
&self,
) -> &ExecutionLifecycle<<FEN as FoundryEvmNetwork>::EvmFactory>
pub const fn lifecycle( &self, ) -> &ExecutionLifecycle<<FEN as FoundryEvmNetwork>::EvmFactory>
Returns the execution lifecycle, for read-only inspection of contexts and forks.
Sourcepub fn evm_env(
&self,
) -> EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>
pub fn evm_env( &self, ) -> EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>
Returns the environment of the active context, as of the last park, with a fork’s own chain ID.
Sourcepub fn evm_env_mut(
&mut self,
) -> &mut EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>
pub fn evm_env_mut( &mut self, ) -> &mut EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>
Returns the environment of the active context for modification between executions.
Sourcepub fn set_spec_id(
&mut self,
spec: impl Into<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId>,
) -> &mut Backend<FEN>
pub fn set_spec_id( &mut self, spec: impl Into<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId>, ) -> &mut Backend<FEN>
Sets the spec of the active context, keeping Foundry’s execution policy.
Sourcepub fn create_evm<'a>(
&self,
) -> Evm<'a, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>
pub fn create_evm<'a>( &self, ) -> Evm<'a, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>
Creates an EVM over the active context. See the module documentation.
Sourcepub fn park(
&mut self,
evm: Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
)
pub fn park( &mut self, evm: Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, )
Accepts a committed EVM’s state, environment and network state into the active context,
and detaches the block access list set with Self::set_bal.
Sourcepub fn remove_prewarm(&mut self, state: &mut State<'_>, address: &Address)
pub fn remove_prewarm(&mut self, state: &mut State<'_>, address: &Address)
Removes address from the running transaction’s base warmth, see
ExecutionLifecycle::remove_prewarm.
Sourcepub fn take_persistent_warmth(
&mut self,
) -> Vec<(Option<Uint<256, 4>>, HashMap<Address, HashSet<Uint<256, 4>, DefaultHashBuilder>, FbBuildHasher<20>>)>
pub fn take_persistent_warmth( &mut self, ) -> Vec<(Option<Uint<256, 4>>, HashMap<Address, HashSet<Uint<256, 4>, DefaultHashBuilder>, FbBuildHasher<20>>)>
Takes the persistent warmth contexts kept for the running transaction, see
ExecutionLifecycle::take_persistent_warmth.
Sourcepub fn restore_persistent_warmth(
&mut self,
warmth: Vec<(Option<Uint<256, 4>>, HashMap<Address, HashSet<Uint<256, 4>, DefaultHashBuilder>, FbBuildHasher<20>>)>,
)
pub fn restore_persistent_warmth( &mut self, warmth: Vec<(Option<Uint<256, 4>>, HashMap<Address, HashSet<Uint<256, 4>, DefaultHashBuilder>, FbBuildHasher<20>>)>, )
Hands back persistent warmth taken with Self::take_persistent_warmth.
Sourcepub fn inspect_commit<'a>(
&mut self,
tx: &Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>,
inspector: impl Inspector<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types> + 'a,
) -> Result<TxResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::TxResultExt>, Report>
pub fn inspect_commit<'a>( &mut self, tx: &Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>, inspector: impl Inspector<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types> + 'a, ) -> Result<TxResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::TxResultExt>, Report>
Executes tx over the active context with inspector and accepts its state.
Sourcepub fn initialize(&mut self, caller: Address, kind: TxKind)
pub fn initialize(&mut self, caller: Address, kind: TxKind)
Records the caller and test contract of the next test execution.
The test contract is the call target, or the address caller creates at its current nonce.
Sourcepub fn basic(
&self,
address: Address,
) -> Result<Option<AccountInfo>, DatabaseError>
pub fn basic( &self, address: Address, ) -> Result<Option<AccountInfo>, DatabaseError>
Returns an account of the active context’s accepted state.
Sourcepub fn code_by_hash(
&self,
code_hash: FixedBytes<32>,
) -> Result<Bytecode, DatabaseError>
pub fn code_by_hash( &self, code_hash: FixedBytes<32>, ) -> Result<Bytecode, DatabaseError>
Returns code of the active context’s accepted state.
Sourcepub fn storage(
&self,
address: Address,
slot: Uint<256, 4>,
) -> Result<Uint<256, 4>, DatabaseError>
pub fn storage( &self, address: Address, slot: Uint<256, 4>, ) -> Result<Uint<256, 4>, DatabaseError>
Returns a storage slot of the active context’s accepted state.
Sourcepub fn block_hash(
&self,
number: Uint<256, 4>,
) -> Result<FixedBytes<32>, DatabaseError>
pub fn block_hash( &self, number: Uint<256, 4>, ) -> Result<FixedBytes<32>, DatabaseError>
Returns a block hash of the active context.
Sourcepub fn insert_account_info(&mut self, address: Address, account: AccountInfo)
pub fn insert_account_info(&mut self, address: Address, account: AccountInfo)
Inserts account info into the active context’s accepted state.
Use this between executions only; a running EVM does not observe it.
Sourcepub fn insert_account_storage(
&mut self,
address: Address,
slot: Uint<256, 4>,
value: Uint<256, 4>,
)
pub fn insert_account_storage( &mut self, address: Address, slot: Uint<256, 4>, value: Uint<256, 4>, )
Inserts a value into an account’s storage without overriding account info.
Use this between executions only; a running EVM does not observe it.
Sourcepub fn replace_account_storage(
&mut self,
address: Address,
storage: impl IntoIterator<Item = (Uint<256, 4>, Uint<256, 4>)>,
)
pub fn replace_account_storage( &mut self, address: Address, storage: impl IntoIterator<Item = (Uint<256, 4>, Uint<256, 4>)>, )
Replaces an account’s storage without overriding account info.
When forking, every slot not in storage reads as zero instead of being fetched. Use this
between executions only; a running EVM does not observe it.
Sourcepub fn set_env(
&mut self,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
phase: ExecutionPhase,
)
pub fn set_env( &mut self, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, phase: ExecutionPhase, )
Switches the running evm to env, such as for vm.chainId or vm.setEvmVersion. See
ExecutionLifecycle::set_env.
Sourcepub fn commit_pending(&mut self, pending: &PendingState)
pub fn commit_pending(&mut self, pending: &PendingState)
Accepts a detached transaction’s state, such as a call’s, into the active context’s accepted state.
Use this between executions only; a running EVM does not observe it.
Sourcepub fn set_test_contract(&mut self, account: Address) -> &mut Backend<FEN>
pub fn set_test_contract(&mut self, account: Address) -> &mut Backend<FEN>
Sets the address of the DSTest contract that is being executed.
This marks the contract as persistent and grants it cheatcode access.
Sourcepub fn set_caller(&mut self, account: Address) -> &mut Backend<FEN>
pub fn set_caller(&mut self, account: Address) -> &mut Backend<FEN>
Sets the caller address and grants it cheatcode access.
Sourcepub const fn has_state_snapshot_failure(&self) -> bool
pub const fn has_state_snapshot_failure(&self) -> bool
Returns whether a reverted state snapshot recorded a test failure.
If an error occurs in a restored state snapshot, the test is considered failed.
Sourcepub const fn set_state_snapshot_failure(
&mut self,
has_state_snapshot_failure: bool,
)
pub const fn set_state_snapshot_failure( &mut self, has_state_snapshot_failure: bool, )
Sets the state snapshot failure flag.
Sourcepub fn is_persistent(&self, account: &Address) -> bool
pub fn is_persistent(&self, account: &Address) -> bool
Returns whether account persists across fork switches.
Sourcepub fn add_persistent_account(&mut self, account: Address) -> bool
pub fn add_persistent_account(&mut self, account: Address) -> bool
Marks account as persistent across fork switches. Returns whether it was not yet.
Sourcepub fn remove_persistent_account(&mut self, account: &Address) -> bool
pub fn remove_persistent_account(&mut self, account: &Address) -> bool
Stops account from persisting across fork switches. Returns whether it was persistent.
Sourcepub fn extend_persistent_accounts(
&mut self,
accounts: impl IntoIterator<Item = Address>,
)
pub fn extend_persistent_accounts( &mut self, accounts: impl IntoIterator<Item = Address>, )
Marks all accounts as persistent.
Sourcepub fn allow_cheatcode_access(&mut self, account: Address) -> bool
pub fn allow_cheatcode_access(&mut self, account: Address) -> bool
Grants account cheatcode access. Returns whether it did not have access yet.
Sourcepub fn has_cheatcode_access(&self, account: &Address) -> bool
pub fn has_cheatcode_access(&self, account: &Address) -> bool
Returns whether account has cheatcode access.
Sourcepub fn ensure_cheatcode_access(
&self,
account: &Address,
) -> Result<(), BackendError>
pub fn ensure_cheatcode_access( &self, account: &Address, ) -> Result<(), BackendError>
Ensures that account has cheatcode access.
Sourcepub fn ensure_cheatcode_access_forking_mode(
&self,
account: &Address,
) -> Result<(), BackendError>
pub fn ensure_cheatcode_access_forking_mode( &self, account: &Address, ) -> Result<(), BackendError>
Like Self::ensure_cheatcode_access, but only enforced while forked.
Sourcepub const fn active_fork_id(&self) -> Option<Uint<256, 4>>
pub const fn active_fork_id(&self) -> Option<Uint<256, 4>>
Returns the active fork, or None for local execution.
Sourcepub const fn is_forked_mode(&self) -> bool
pub const fn is_forked_mode(&self) -> bool
Returns whether execution is forked.
Sourcepub fn is_active_fork(&self, id: Uint<256, 4>) -> bool
pub fn is_active_fork(&self, id: Uint<256, 4>) -> bool
Returns whether id is the active fork.
Sourcepub fn active_fork_info(&self) -> Option<&ForkInfo>
pub fn active_fork_info(&self) -> Option<&ForkInfo>
Returns the identity of the active fork.
Sourcepub fn active_fork_url(&self) -> Option<String>
pub fn active_fork_url(&self) -> Option<String>
Returns the RPC URL of the active fork.
Sourcepub fn active_fork_options(&self) -> Option<CreateFork>
pub fn active_fork_options(&self) -> Option<CreateFork>
Returns the configuration the active fork was created with.
Sourcepub fn active_fork_source_chain_id(&self) -> Option<u64>
pub fn active_fork_source_chain_id(&self) -> Option<u64>
Returns the source chain ID of the active fork, independent of chain ID overrides.
Sourcepub fn active_fork_block_number(&self) -> Option<u64>
pub fn active_fork_block_number(&self) -> Option<u64>
Returns the RPC block number of the active fork.
Sourcepub fn ensure_fork(
&self,
id: Option<Uint<256, 4>>,
) -> Result<Uint<256, 4>, Report>
pub fn ensure_fork( &self, id: Option<Uint<256, 4>>, ) -> Result<Uint<256, 4>, Report>
Returns id, or the active fork for None, if it exists.
Sourcepub fn create_fork(&mut self, fork: CreateFork) -> Result<Uint<256, 4>, Report>
pub fn create_fork(&mut self, fork: CreateFork) -> Result<Uint<256, 4>, Report>
Creates a fork without selecting it.
Sourcepub fn create_fork_at_transaction(
&mut self,
fork: CreateFork,
transaction: FixedBytes<32>,
) -> Result<Uint<256, 4>, Report>
pub fn create_fork_at_transaction( &mut self, fork: CreateFork, transaction: FixedBytes<32>, ) -> Result<Uint<256, 4>, Report>
Creates a fork positioned right before transaction without selecting it.
Sourcepub fn create_select_fork(
&mut self,
fork: CreateFork,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
phase: ExecutionPhase,
) -> Result<Uint<256, 4>, Report>
pub fn create_select_fork( &mut self, fork: CreateFork, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, phase: ExecutionPhase, ) -> Result<Uint<256, 4>, Report>
Creates a fork and selects it.
Sourcepub fn create_select_fork_at_transaction(
&mut self,
fork: CreateFork,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
phase: ExecutionPhase,
transaction: FixedBytes<32>,
) -> Result<Uint<256, 4>, Report>
pub fn create_select_fork_at_transaction( &mut self, fork: CreateFork, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, phase: ExecutionPhase, transaction: FixedBytes<32>, ) -> Result<Uint<256, 4>, Report>
Creates a fork positioned right before transaction and selects it.
Sourcepub fn select_fork(
&mut self,
id: Uint<256, 4>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
phase: ExecutionPhase,
) -> Result<(), Report>
pub fn select_fork( &mut self, id: Uint<256, 4>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, phase: ExecutionPhase, ) -> Result<(), Report>
Makes fork id the running context of evm.
The running spec and fee-charge policy carry over to the fork; persistent accounts carry their state into it.
Sourcepub fn roll_fork(
&mut self,
id: Option<Uint<256, 4>>,
block_number: u64,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
phase: ExecutionPhase,
) -> Result<(), Report>
pub fn roll_fork( &mut self, id: Option<Uint<256, 4>>, block_number: u64, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, phase: ExecutionPhase, ) -> Result<(), Report>
Moves fork id, or the active fork for None, to block_number.
Sourcepub fn roll_fork_to_transaction(
&mut self,
id: Option<Uint<256, 4>>,
transaction: FixedBytes<32>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
phase: ExecutionPhase,
) -> Result<(), Report>
pub fn roll_fork_to_transaction( &mut self, id: Option<Uint<256, 4>>, transaction: FixedBytes<32>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, phase: ExecutionPhase, ) -> Result<(), Report>
Moves fork id, or the active fork for None, to the state right before transaction:
the transaction’s block environment over its parent’s state with the block’s preceding
transactions replayed natively.
Sourcepub fn prepare_transact(
&self,
id: Option<Uint<256, 4>>,
transaction: FixedBytes<32>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
depth: u16,
isolation_env: Option<&EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>,
) -> Result<(PreparedTx<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, CowBackend<'_, FEN>), Report>
pub fn prepare_transact( &self, id: Option<Uint<256, 4>>, transaction: FixedBytes<32>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, depth: u16, isolation_env: Option<&EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>, ) -> Result<(PreparedTx<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, CowBackend<'_, FEN>), Report>
Prepares the mined transaction of fork id, or of the active fork for None, to execute
with its block’s environment, such as for vm.transact, and returns it with the throwaway
backend it executes over. Store the outcome with Self::store_executed.
On the active fork the transaction runs as a nested transaction of the running one, whose
writes are journaled; on another fork it is accepted there and its changes to persistent
accounts are merged into the running transaction. Its root frame runs at depth.
Cheatcodes running in the transaction see the throwaway backend with the target fork active at the transaction’s block; their changes to it are discarded.
isolation_env is the environment of the transaction an isolated call runs in, whose fee
charge and sender balance checks apply on the active fork instead of the isolated call’s.
Sourcepub fn transact_from_tx(
&mut self,
tx: &Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
env: Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>,
inspector: Option<&mut dyn Inspector<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>,
) -> Result<(TxResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::TxResultExt>, Vec<PersistentWrite>), Report>
pub fn transact_from_tx( &mut self, tx: &Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, env: Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>, inspector: Option<&mut dyn Inspector<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>, ) -> Result<(TxResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::TxResultExt>, Vec<PersistentWrite>), Report>
Executes tx as a nested transaction of the running one, in env or the running
environment for None, and merges its changes into the running transaction so that they
survive reverts of the enclosing calls.
Sourcepub fn prepare_nested(
&self,
tx: Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
env: Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>,
) -> (PreparedTx<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, CowBackend<'_, FEN>)
pub fn prepare_nested( &self, tx: Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, env: Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>, ) -> (PreparedTx<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, CowBackend<'_, FEN>)
Prepares Self::transact_from_tx, such as for vm.broadcastRawTransaction, and returns
it with the throwaway backend it executes over. Store the outcome with
Self::store_executed.
Cheatcodes running in the transaction see the throwaway backend, a copy-on-write view of this one; their changes to it are discarded.
Sourcepub fn store_executed(
&mut self,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
executed: ExecutedNested<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> TxResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::TxResultExt>
pub fn store_executed( &mut self, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, executed: ExecutedNested<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> TxResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::TxResultExt>
Stores the outcome of a transaction prepared with Self::prepare_transact or
Self::prepare_nested.
A replayed canonical transaction advances its fork’s position; its changes merged into the
running transaction evm are not the running transaction’s execution.
Sourcepub fn diagnose_revert(
&self,
callee: Address,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Option<RevertDiagnostic>
pub fn diagnose_revert( &self, callee: Address, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Option<RevertDiagnostic>
Explains a revert of a call to callee in multi-fork mode: whether callee has no code on
the active fork, and on which other forks it does.
Handling multiple accounts/new contracts in a multifork environment can be challenging since every fork has its own standalone storage section:
function testCanDeploy() public {
vm.selectFork(mainnetFork);
// contract created while on `mainnetFork`
DummyContract dummy = new DummyContract();
// this will succeed
dummy.hello();
vm.selectFork(optimismFork);
vm.expectRevert();
// this will revert since `dummy` contract only exists on `mainnetFork`
dummy.hello();
}Sourcepub fn load_allocs(
&self,
allocs: &BTreeMap<Address, GenesisAccount>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<(), BackendError>
pub fn load_allocs( &self, allocs: &BTreeMap<Address, GenesisAccount>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<(), BackendError>
Loads genesis allocs into the running transaction as journaled writes.
Sourcepub fn clone_account(
&self,
source: &GenesisAccount,
target: &Address,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<(), BackendError>
pub fn clone_account( &self, source: &GenesisAccount, target: &Address, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<(), BackendError>
Writes the code, storage, nonce and balance of source to target in the running
transaction as journaled writes, and warms target. Code is kept when source has none.
Sourcepub fn set_blockhash(
&self,
number: Uint<256, 4>,
hash: FixedBytes<32>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
)
pub fn set_blockhash( &self, number: Uint<256, 4>, hash: FixedBytes<32>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, )
Sets the hash of block number in the running context.
Sourcepub fn refresh_fork_account(
&self,
address: Address,
field: ForkAccountField,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<(), BackendError>
pub fn refresh_fork_account( &self, address: Address, field: ForkAccountField, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<(), BackendError>
Refetches field of address from the active fork’s remote, after an out-of-band RPC
mutation, and updates the running context with it.
Balance and nonce are overridden without journaling, so they survive reverts; code is set as a journaled write.
Sourcepub fn refresh_fork_storage(
&mut self,
address: Address,
slot: Uint<256, 4>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Result<Option<PersistentWrite>, BackendError>
pub fn refresh_fork_storage( &mut self, address: Address, slot: Uint<256, 4>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Result<Option<PersistentWrite>, BackendError>
Refetches storage slot of address from the active fork’s remote, after an out-of-band
RPC mutation, and updates the running context with it.
A slot the running transaction already loaded takes the refreshed value across reverts of the enclosing calls. Its transaction-start original is kept.
Sourcepub fn prefetch_call(
&self,
caller: Address,
target: Address,
value: Uint<256, 4>,
input: Bytes,
top_level: bool,
)
pub fn prefetch_call( &self, caller: Address, target: Address, value: Uint<256, 4>, input: Bytes, top_level: bool, )
Prefetches the remote state a call is about to read, if the active context is an RPC fork.
A top_level call is simulated with the local state that differs from the remote, such as
the test contract, as overrides. A nested call is simulated as is.
Sourcepub fn snapshot_state(
&mut self,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
) -> Uint<256, 4>
pub fn snapshot_state( &mut self, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, ) -> Uint<256, 4>
Captures the running context and every fork, and returns the snapshot ID.
Sourcepub fn revert_state(
&mut self,
id: Uint<256, 4>,
evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>,
action: RevertStateSnapshotAction,
phase: ExecutionPhase,
) -> Option<StateSnapshot>
pub fn revert_state( &mut self, id: Uint<256, 4>, evm: &mut Evm<'_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, action: RevertStateSnapshotAction, phase: ExecutionPhase, ) -> Option<StateSnapshot>
Restores snapshot id and returns the running state it replaced, or returns None if it
does not exist.
Logs emitted since the snapshot, persistent accounts and forks created after it survive.
A test failure recorded in the reverted state sets Self::has_state_snapshot_failure.
Sourcepub fn delete_state_snapshot(&mut self, id: Uint<256, 4>) -> bool
pub fn delete_state_snapshot(&mut self, id: Uint<256, 4>) -> bool
Deletes a snapshot, returning whether it existed.
Sourcepub fn delete_state_snapshots(&mut self)
pub fn delete_state_snapshots(&mut self)
Deletes every snapshot.
Trait Implementations§
Source§impl<FEN> CheatcodesBackend<FEN> for Backend<FEN>where
FEN: FoundryEvmNetwork,
impl<FEN> CheatcodesBackend<FEN> for Backend<FEN>where
FEN: FoundryEvmNetwork,
Auto Trait Implementations§
impl<FEN = EthEvmNetwork> !RefUnwindSafe for Backend<FEN>
impl<FEN = EthEvmNetwork> !UnwindSafe for Backend<FEN>
impl<FEN> Freeze for Backend<FEN>
impl<FEN> Send for Backend<FEN>
impl<FEN> Sync for Backend<FEN>
impl<FEN> Unpin for Backend<FEN>
impl<FEN> UnsafeUnpin for Backend<FEN>
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
§impl<T> Conv for T
impl<T> Conv for T
impl<T> ErasedDestructor for Twhere
T: 'static,
§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<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
§fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
TxEnv] from a transaction, its sender, and encoded transaction bytes.§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> 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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Layered].impl<T> MaybeCompact for T
§impl<D> OwoColorize for D
impl<D> OwoColorize for D
§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg] or
a color-specific method, such as [OwoColorize::green], Read more§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg] or
a color-specific method, such as [OwoColorize::on_yellow], Read more§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
§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>
renamed to 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> Read<Exclusive, BecauseExclusive> 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> Threaded<T> for T
impl<T> Threaded<T> for T
§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> ⓘ
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.