Skip to main content

Cheatcodes

Struct Cheatcodes 

Source
pub struct Cheatcodes<FEN = EthEvmNetwork>
where FEN: FoundryEvmNetwork,
{
Show 75 fields pub core: CheatcodesCore, pub block: Option<BlockEnvExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::BlockEnvExt>>, pub fork_block_number_override: Option<u64>, pub active_delegations: Vec<SignedAuthorization>, pub active_blob_sidecar: Option<BlobTransactionSidecarVariant>, pub gas_price: Option<u128>, pub fee_token: Option<Address>, pub origin_override: Option<Address>, pending_origin_override: bool, pending_gas_price: bool, pending_emit_failure: Option<&'static str>, pub state_epoch: u64, pub fork_epoch: u64, pub snapshot_restores: SnapshotRestores, pub root_call_target: Option<Address>, pub root_depth: usize, pub tx_warm_addresses: Vec<Address>, pub pranks: BTreeMap<usize, Prank>, pub expected_revert: Option<ExpectedRevert>, pub assume_no_revert: Option<AssumeNoRevert>, pub fork_revert_diagnostic: Option<RevertDiagnostic>, pub accesses: RecordAccess, pub recording_accesses: bool, pub recorded_account_diffs_stack: Option<Vec<Vec<AccountAccess>>>, pending_account_diffs: Option<Arc<[AccountAccess]>>, recorded_account_diffs_prefix: Option<Arc<[AccountAccess]>>, created_accounts: Vec<Address>, created_account_bindings: HashMap<(Option<Uint<256, 4>>, Address), usize, DefaultHashBuilder>, created_account_changes: Vec<CreatedAccountChange>, created_accounts_frames: Vec<CreatedAccountsFrame>, created_accounts_snapshots: HashMap<Uint<256, 4>, CreatedAccountsSnapshot, DefaultHashBuilder>, pub record_debug_steps_info: Option<RecordDebugStepInfo>, pub expected_emits: VecDeque<(ExpectedEmit, HashMap<Address, LogCountMap, FbBuildHasher<20>>)>, pub expected_creates: Vec<ExpectedCreate>, pub allowed_mem_writes: HashMap<u64, Vec<Range<u64>>, DefaultHashBuilder>, pub broadcast: Option<Broadcast>, pub broadcastable_transactions: VecDeque<BroadcastableTransaction<<FEN as FoundryEvmNetwork>::Network>>, pub extra_cheatcode_addresses: &'static [Address], pub skip_payloads: Vec<Bytes>, pub persistent_writes: Vec<(usize, usize, PersistentWrite)>, pub frame_rollback: Option<(usize, usize)>, pub persistent_write_snapshots: HashMap<Uint<256, 4>, usize, DefaultHashBuilder>, pub failed_assertion: Option<String>, pub failure_trace: Option<FailureTrace>, pub failure_provenance: Option<FailureProvenance>, pub gas_metering: GasMetering, pub gas_snapshots: BTreeMap<String, BTreeMap<String, String>>, pub pc: usize, pub breakpoints: HashMap<char, (Address, usize), DefaultHashBuilder>, pub ignored_traces: IgnoredTraces, storage_load_hooks: HashMap<Address, StorageHook, FbBuildHasher<20>>, storage_store_hooks: HashMap<Address, StorageHook, FbBuildHasher<20>>, mapping_storage_store_hooks: HashMap<Address, HashMap<FixedBytes<32>, StorageHook, DefaultHashBuilder>, FbBuildHasher<20>>, storage_hook_mapping_slots: HashMap<Address, MappingSlots, FbBuildHasher<20>>, pending_mapping_hash: Option<PendingMappingHash>, storage_hooks_registered: bool, pending_storage_hook: Option<PendingStorageHook>, active_storage_hook: Option<ActiveStorageHook>, pub deprecated: HashMap<&'static str, Option<&'static str>, DefaultHashBuilder>, pub script_address: Option<Address>, signatures_identifier: OnceLock<Option<SignaturesIdentifier>>, pub dynamic_gas_limit: bool, pub execution_evm_version: Option<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId>, pub env_overrides: EnvOverrideState, pub fork_block_number_override_snapshots: HashMap<Uint<256, 4>, Option<u64>, DefaultHashBuilder>, pub in_isolation_context: bool, pub isolation_env: Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>, pub in_replay: bool, pub deploy_code_depth: Option<usize>, pub deploy_code_create_state_gas: u64, pub deploy_code_output: Option<(Bytes, bool)>, pub applied_access_list: Option<AccessList>, pub unrun_create_depth: Option<usize>, pub env_handoff_creator: Option<Address>, pub pending_create2_redirects: Vec<(u16, Option<Address>, bool)>,
}
Expand description

An EVM inspector that handles calls to various cheatcodes, each with their own behavior.

Cheatcodes can be called by contracts during execution to modify the VM environment, such as mocking addresses, signatures and altering call reverts.

Executing cheatcodes can be very powerful. Most cheatcodes are limited to evm internals, but there are also cheatcodes like ffi which can execute arbitrary commands or writeFile and readFile which can manipulate files of the filesystem. Therefore, several restrictions are implemented for these cheatcodes:

  • ffi, and file cheatcodes are always opt-in (via foundry config) and never enabled by default: all respective cheatcode handlers implement the appropriate checks
  • File cheatcodes require explicit permissions which paths are allowed for which operation, see Config.fs_permission
  • Only permitted accounts are allowed to execute cheatcodes in forking mode, this ensures no contract deployed on the live network is able to execute cheatcodes by simply calling the cheatcode address: by default, the caller, test contract and newly deployed contracts are allowed to execute cheatcodes

Fields§

§core: CheatcodesCore

Engine-independent cheatcode state.

§block: Option<BlockEnvExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::BlockEnvExt>>

The block environment

Used in the cheatcode handler to overwrite the block environment separately from the execution block environment.

§fork_block_number_override: Option<u64>

The active fork block override updated by a fork-switching cheatcode.

This persists fork changes made through a copy-on-write backend between invariant calls.

§active_delegations: Vec<SignedAuthorization>

Currently active EIP-7702 delegations that will be consumed when building the next transaction. Set by vm.attachDelegation() and consumed via .take() during transaction construction.

§active_blob_sidecar: Option<BlobTransactionSidecarVariant>

The active EIP-4844 blob that will be attached to the next call.

§gas_price: Option<u128>

The gas price.

Executions run fee-less, so the GASPRICE opcode reads this value instead, unless vm.txGasPrice overrides it.

§fee_token: Option<Address>

The fee token of the executed transactions, recorded in broadcast requests.

§origin_override: Option<Address>

The tx.origin set by a prank or broadcast, which the ORIGIN opcode reads instead of the transaction’s origin.

evm2 borrows the transaction environment for the whole transaction, so origin changes are applied at the opcode level.

§pending_origin_override: bool§pending_gas_price: bool§pending_emit_failure: Option<&'static str>§state_epoch: u64

Incremented whenever a cheatcode replaces the running state outside of a snapshot restoration, such as a fork switch, so nested executions know to adopt the replaced state.

§fork_epoch: u64

Incremented whenever a cheatcode switches or rolls forks, bumped together with state_epoch.

§snapshot_restores: SnapshotRestores

Running states replaced by snapshot restorations in the open frames of the running transaction, reinstated when a frame that was open at the restoration fails.

§root_call_target: Option<Address>

Target of the root call of the running transaction, if it is a call.

While an isolated call or create runs as a nested transaction, this is the target of that transaction instead.

§root_depth: usize

Call depth of the running transaction’s top-level calls, set by the inspector stack when each one starts.

This is the EVM’s initial call depth, which is zero unless the transaction handler runs the calls below the transaction, such as Tempo’s for the calls of an AA transaction. Nested transactions, such as isolated calls and replays, keep the running transaction’s.

§tx_warm_addresses: Vec<Address>

The EIP-3651 coinbase and access-list addresses the running transaction warmed when it started, which vm.cool keeps warm.

While an isolated call or create runs as a nested transaction, these are that transaction’s instead.

§pranks: BTreeMap<usize, Prank>

Prank information, mapped to the call depth where pranks were added.

§expected_revert: Option<ExpectedRevert>

Expected revert information

§assume_no_revert: Option<AssumeNoRevert>

Assume next call can revert and discard fuzz run if it does.

§fork_revert_diagnostic: Option<RevertDiagnostic>

Additional diagnostic for reverts

§accesses: RecordAccess

Recorded storage reads and writes

§recording_accesses: bool

Whether storage access recording is currently active

§recorded_account_diffs_stack: Option<Vec<Vec<AccountAccess>>>

Recorded account accesses (calls, creates) organized by relative call depth, where the topmost vector corresponds to accesses at the depth at which account access recording began. Each vector in the matrix represents a list of accesses at a specific call depth. Once that call context has ended, the last vector is removed from the matrix and merged into the previous vector.

§pending_account_diffs: Option<Arc<[AccountAccess]>>§recorded_account_diffs_prefix: Option<Arc<[AccountAccess]>>§created_accounts: Vec<Address>§created_account_bindings: HashMap<(Option<Uint<256, 4>>, Address), usize, DefaultHashBuilder>§created_account_changes: Vec<CreatedAccountChange>§created_accounts_frames: Vec<CreatedAccountsFrame>§created_accounts_snapshots: HashMap<Uint<256, 4>, CreatedAccountsSnapshot, DefaultHashBuilder>§record_debug_steps_info: Option<RecordDebugStepInfo>

The information of the debug step recording.

§expected_emits: VecDeque<(ExpectedEmit, HashMap<Address, LogCountMap, FbBuildHasher<20>>)>

Expected emits

§expected_creates: Vec<ExpectedCreate>

Expected creates

§allowed_mem_writes: HashMap<u64, Vec<Range<u64>>, DefaultHashBuilder>

Map of context depths to memory offset ranges that may be written to within the call depth.

§broadcast: Option<Broadcast>

Current broadcasting information

§broadcastable_transactions: VecDeque<BroadcastableTransaction<<FEN as FoundryEvmNetwork>::Network>>

Scripting based transactions

§extra_cheatcode_addresses: &'static [Address]

Additional addresses recognized as cheatcode contracts by this executor.

§skip_payloads: Vec<Bytes>

Revert payloads minted by the skip cheatcode during the current test call.

A top-level revert is only classified as a skip when its data byte-equals one of these payloads, so user-crafted FOUNDRY::SKIP revert data never skips a test on its own.

§persistent_writes: Vec<(usize, usize, PersistentWrite)>

Writes that survive reverts of the enclosing calls, with the depth of the frame that made them and the journal length right after them, replayed when that frame or an enclosing one reverts and its rollback undid them. Writes accepted outside the journal have length zero, see Self::record_accepted.

§frame_rollback: Option<(usize, usize)>

The depth of the frame that ended last and the journal length of its checkpoint, which a failure rolls the frame back to, recorded by the inspector stack.

§persistent_write_snapshots: HashMap<Uint<256, 4>, usize, DefaultHashBuilder>

The number of persistent writes recorded when each snapshot of the running transaction was taken, capped by the restorations that dropped some of them since.

§failed_assertion: Option<String>

Message of the first vm.assert* cheatcode that failed during the current call.

Unlike the global failure slot, this survives reverts, so callers still see the failure when the asserting call reverts afterwards.

§failure_trace: Option<FailureTrace>

Records failures by call site while set, so minimizers can tell failures apart.

§failure_provenance: Option<FailureProvenance>

Records where each call failed while set, so a replay can check it failed the same way.

§gas_metering: GasMetering

Gas metering state.

§gas_snapshots: BTreeMap<String, BTreeMap<String, String>>

Contains gas snapshots made over the course of a test suite.

§pc: usize

The current program counter.

§breakpoints: HashMap<char, (Address, usize), DefaultHashBuilder>

Breakpoints supplied by the breakpoint cheatcode. char -> (address, pc)

§ignored_traces: IgnoredTraces

Ignored traces.

§storage_load_hooks: HashMap<Address, StorageHook, FbBuildHasher<20>>§storage_store_hooks: HashMap<Address, StorageHook, FbBuildHasher<20>>§mapping_storage_store_hooks: HashMap<Address, HashMap<FixedBytes<32>, StorageHook, DefaultHashBuilder>, FbBuildHasher<20>>§storage_hook_mapping_slots: HashMap<Address, MappingSlots, FbBuildHasher<20>>§pending_mapping_hash: Option<PendingMappingHash>§storage_hooks_registered: bool§pending_storage_hook: Option<PendingStorageHook>§active_storage_hook: Option<ActiveStorageHook>§deprecated: HashMap<&'static str, Option<&'static str>, DefaultHashBuilder>

Deprecated cheatcodes mapped to the reason. Used to report warnings on test results.

§script_address: Option<Address>

Main script contract, when script execution protection is enabled.

§signatures_identifier: OnceLock<Option<SignaturesIdentifier>>§dynamic_gas_limit: bool

Used to determine whether the broadcasted call has dynamic gas limit.

§execution_evm_version: Option<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId>§env_overrides: EnvOverrideState

Per-fork opcode environment overrides and their state-snapshot copies.

§fork_block_number_override_snapshots: HashMap<Uint<256, 4>, Option<u64>, DefaultHashBuilder>

Per-state-snapshot copies of Self::fork_block_number_override.

§in_isolation_context: bool

Whether we are currently executing inside an isolation context, i.e. the nested transaction an isolated call (--isolate, --gas-report) executes as.

Cheatcodes that mutate the tx/block env consult this flag and route the change through EnvOverrides instead of the actual env when true, so they don’t fight with the fee-accounting zeroing.

§isolation_env: Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>

Environment of the transaction an isolated call runs in, while it runs.

The isolated call’s own nested transaction pays no fees; transactions that cheatcodes execute inside it start from this environment instead.

§in_replay: bool

Whether a replay is running whose fork-context changes cannot be merged into its parent.

§deploy_code_depth: Option<usize>

Depth of the in-flight deployCode call, whose create frame runs one level deeper.

§deploy_code_create_state_gas: u64

Account-creation state gas the in-flight deployCode call already charged its caller for its create frame.

§deploy_code_output: Option<(Bytes, bool)>

Output the in-flight deployCode call’s constructor returned, which the EVM drops if depositing it fails, and whether the constructor ran in an isolated call.

§applied_access_list: Option<AccessList>

The vm.accessList the running transaction last applied to a call or create. It replaces the transaction’s access list when computing its stipend.

§unrun_create_depth: Option<usize>

Depth of a create that a hook ended with a revert without running its frame.

§env_handoff_creator: Option<Address>

Code that issued the CREATE being handed off to a new frame EVM.

§pending_create2_redirects: Vec<(u16, Option<Address>, bool)>

Automatic CREATE2 redirects: factory call depth, original issuing code, and whether the original create grants cheatcode access. The grant is resolved after caller overrides.

Implementations§

Source§

impl<FEN> Cheatcodes<FEN>
where FEN: FoundryEvmNetwork,

Source

pub fn new(config: Arc<CheatsConfig>) -> Cheatcodes<FEN>

Creates a new Cheatcodes with the given settings.

Source

pub const fn set_extra_cheatcode_addresses( &mut self, addresses: &'static [Address], )

Sets additional addresses recognized as cheatcode contracts.

Source

pub fn start_internal_state_diff_recording(&mut self) -> bool

Starts an internal account diff recording session for test runner setup.

Source

pub fn stop_internal_state_diff_recording(&mut self) -> Vec<AccountAccess>

Stops an internal account diff recording session without leaving recording enabled.

Source

pub fn set_pending_account_diffs(&mut self, accesses: Vec<AccountAccess>)

Makes account accesses captured by the test runner available to the next recording session.

Source

pub fn start_state_diff_recording(&mut self)

Starts a user account diff recording session, including pending test runner accesses.

Source

pub fn recorded_account_diffs(&self) -> impl Iterator<Item = &AccountAccess>

Returns completed and active account accesses in execution order.

Source

pub fn take_recorded_account_diffs_prefix(&mut self) -> Vec<AccountAccess>

Takes completed account accesses from the active user recording session.

Source

pub fn get_prank(&self, depth: usize) -> Option<&Prank>

Returns the configured prank at given depth or the first prank configured at a lower depth. For example, if pranks configured for depth 1, 3 and 5, the prank for depth 4 is the one configured at depth 3.

Source

pub fn add_delegation(&mut self, authorization: SignedAuthorization)

Adds a delegation to the active delegations list.

Source

pub fn signatures_identifier(&self) -> Option<&SignaturesIdentifier>

Returns the signatures identifier.

Source

pub fn call_with_executor( &mut self, interp: &mut Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, call: &mut MessageExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageExt>, backend: &mut dyn CheatcodesBackend<FEN>, executor: &mut dyn CheatcodesExecutor<FEN>, isolate_call: bool, ) -> Option<MessageResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageResultExt>>

Handles a call, accounting for whether the executor will isolate it as a transaction.

If isolate_call is true, the executor owns the transaction nonce increment when the call proceeds to execution.

Source

pub fn arbitrary_storage_targets(&self) -> impl Iterator<Item = Address>

Returns addresses explicitly marked with arbitrary storage.

Source

pub fn arbitrary_storage_target_overwrite_modes( &self, ) -> impl Iterator<Item = (Address, bool)>

Returns addresses explicitly marked with arbitrary storage and whether nonzero slots are overwritten.

Source

pub fn arbitrary_storage_copied_targets(&self) -> impl Iterator<Item = Address>

Returns addresses that copy storage from arbitrary-storage targets.

Source

pub fn arbitrary_storage_copied_target_sources( &self, ) -> impl Iterator<Item = (Address, Address)>

Returns copied arbitrary-storage targets and their source address.

Source

pub fn set_arbitrary_storage_replay_value( &mut self, address: Address, slot: Uint<256, 4>, value: Uint<256, 4>, )

Sets the value that arbitrary storage draws for a slot instead of a random one, so a replay reproduces a symbolic counterexample. Slots that are never drawn keep their value.

Source

pub fn mark_arbitrary_storage_slot_explicit( &mut self, address: Address, slot: Uint<256, 4>, )

Marks a slot as explicitly written with vm.store.

Source

pub fn is_arbitrary_storage_slot_explicit( &self, address: Address, slot: Uint<256, 4>, ) -> bool

Returns whether a slot was explicitly written with vm.store.

Source

pub fn cached_arbitrary_storage_value( &self, address: Address, slot: Uint<256, 4>, ) -> Option<Uint<256, 4>>

Returns the value arbitrary storage generated for a slot of an arbitrary-storage address.

Source

pub fn has_arbitrary_storage(&self, address: &Address) -> bool

Whether the given address has arbitrary storage.

Source

pub fn should_overwrite_arbitrary_storage( &self, address: &Address, storage_slot: Uint<256, 4>, ) -> bool

Whether the given slot of address with arbitrary storage should be overwritten. True if address is marked as and overwrite and if no value was previously generated for given slot.

Source

pub fn is_arbitrary_storage_copy(&self, address: &Address) -> bool

Whether the given address is a copy of an address with arbitrary storage.

Source

pub fn register_storage_load_hook( &mut self, target: Address, callback_target: Address, callback_selector: [u8; 4], )

Registers an SLOAD callback, replacing the existing callback for target.

Source

pub fn register_storage_store_hook( &mut self, target: Address, callback_target: Address, callback_selector: [u8; 4], )

Registers an SSTORE callback, replacing the existing callback for target.

Source

pub fn register_mapping_storage_store_hook( &mut self, target: Address, root_slot: FixedBytes<32>, callback_target: Address, callback_selector: [u8; 4], ) -> bool

Registers a mapping SSTORE callback. Returns false when a raw hook conflicts.

Source

pub fn mapping_storage_store_hooks( &self, ) -> impl Iterator<Item = (Address, FixedBytes<32>, StorageHook)>

Returns registered mapping SSTORE callbacks.

Source

pub fn has_mapping_storage_store_hooks(&self, target: Address) -> bool

Returns whether mapping hooks conflict with a raw store hook.

Source

pub fn storage_load_hooks(&self) -> impl Iterator<Item = (Address, StorageHook)>

Returns registered SLOAD callbacks.

Source

pub fn storage_store_hooks( &self, ) -> impl Iterator<Item = (Address, StorageHook)>

Returns registered SSTORE callbacks.

Source

pub const fn has_storage_hooks(&self) -> bool

Returns whether any storage callback is registered.

Source

pub fn clear_storage_hook_mapping_slots(&mut self)

Clears execution-local mapping provenance while preserving hook registrations.

Source

pub const fn is_storage_hook_active(&self) -> bool

Returns whether a synthetic storage-hook callback or one of its child calls is executing.

Source

pub fn is_storage_hook_callback( &self, call: &MessageExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageExt>, ) -> bool

Returns whether call is the synthetic callback for the active storage hook.

Source

pub fn steps(&self) -> OpcodeSet

Returns the opcodes the cheatcodes step: those of Self::hook_steps, and JUMPI while failure provenance is collected.

This is the only place that decides which instructions the cheatcodes step: the inspector asks the EVM for these opcodes, and skips the hooks for every other instruction.

Source

pub fn hook_steps(&self) -> OpcodeSet

Returns the opcodes at which Self::step_hook and Self::step_end_hook must run. The other opcodes of Self::steps only need Self::record_branch.

Source

pub fn record_branch( &mut self, interp: &Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, )

Records the JUMPI about to execute for the failure provenance, as Self::step_hook does. Fuzz campaigns step every JUMPI only for this, so it skips the other hooks.

Source

pub fn has_log_hooks(&self) -> bool

Source

pub fn initialize_interp_hook( &mut self, interp: &mut Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, )

Called after a frame interpreter has been initialized.

Source

pub fn step_hook( &mut self, interp: &mut Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, backend: &mut dyn CheatcodesBackend<FEN>, )

Called before each instruction in Self::steps executes.

Kept out of line: it runs only while a cheatcode needs per-instruction work, and inlining it into the inspector’s per-instruction hook enlarges that hook’s frame for every opcode.

Source

pub fn step_end_hook( &mut self, interp: &mut Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, backend: &mut dyn CheatcodesBackend<FEN>, executor: &mut dyn CheatcodesExecutor<FEN>, )

Called after each instruction in Self::steps executes.

Kept out of line for the same reason as Self::step_hook.

Source

pub fn log_hook(&mut self, log: &Log)

Called when a log is emitted.

Source

pub fn record_persistent( &mut self, depth: usize, state: &State<'_>, writes: impl IntoIterator<Item = PersistentWrite>, )

Records writes the frame at depth just made to state, see Self::persistent_writes.

Source

pub fn record_accepted( &mut self, depth: usize, writes: impl IntoIterator<Item = PersistentWrite>, )

Records writes the frame at depth just accepted into the running state outside the journal, at journal length zero: no rollback undoes them, so only a failing frame that reinstates the state a snapshot restoration replaced replays them.

Source

pub fn call_end_hook( &mut self, interp: &mut Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, call: &MessageExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageExt>, outcome: &mut MessageResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageResultExt>, backend: &mut dyn CheatcodesBackend<FEN>, )

Called after a call message executes.

Source

pub fn create_hook( &mut self, interp: &mut Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, input: &mut MessageExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageExt>, backend: &mut dyn CheatcodesBackend<FEN>, ) -> Option<MessageResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageResultExt>>

Called before a create message executes.

Source

pub fn create_end_hook( &mut self, interp: &mut Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, call: &MessageExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageExt>, outcome: &mut MessageResultExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageResultExt>, _backend: &mut dyn CheatcodesBackend<FEN>, )

Called after a create message executes.

Source

pub fn should_use_create2_factory( &mut self, depth: usize, message: &MessageExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageExt>, ) -> bool

Determines whether the DEFAULT_CREATE2_DEPLOYER should be used for a CREATE message at depth.

Source

pub fn create2_deployer(&self) -> Address

Returns the CREATE2 deployer address.

Source

pub fn start_create2_redirect( &mut self, interp: &Interpreter<'_, '_, <<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, message: &MessageExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::MessageExt>, )

Preserves the original CREATE authorization before redirecting it to the factory.

Trait Implementations§

Source§

impl<FEN> Clone for Cheatcodes<FEN>

Source§

fn clone(&self) -> Cheatcodes<FEN>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<FEN> Debug for Cheatcodes<FEN>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Cheatcodes

Source§

fn default() -> Cheatcodes

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<FEN = EthEvmNetwork> !Freeze for Cheatcodes<FEN>

§

impl<FEN = EthEvmNetwork> !RefUnwindSafe for Cheatcodes<FEN>

§

impl<FEN = EthEvmNetwork> !UnwindSafe for Cheatcodes<FEN>

§

impl<FEN> Send for Cheatcodes<FEN>
where Option<BlockEnvExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::BlockEnvExt>>: Send, VecDeque<BroadcastableTransaction<<FEN as FoundryEvmNetwork>::Network>>: Send, Option<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId>: Send, Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>: Send,

§

impl<FEN> Sync for Cheatcodes<FEN>
where Option<BlockEnvExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::BlockEnvExt>>: Sync, VecDeque<BroadcastableTransaction<<FEN as FoundryEvmNetwork>::Network>>: Sync, Option<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId>: Sync, Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>: Sync,

§

impl<FEN> Unpin for Cheatcodes<FEN>
where Option<BlockEnvExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::BlockEnvExt>>: Unpin, VecDeque<BroadcastableTransaction<<FEN as FoundryEvmNetwork>::Network>>: Unpin, Option<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId>: Unpin, Option<EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>>: Unpin,

§

impl<FEN> UnsafeUnpin for Cheatcodes<FEN>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, R> CollectAndApply<T, R> for T

§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<TxEnv, T> FromRecoveredTx<&T> for TxEnv
where TxEnv: FromRecoveredTx<T>,

§

fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv

Builds a [TxEnv] from a transaction and a sender address.
§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnv
where TxEnv: FromTxWithEncoded<T>,

§

fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv

Builds a [TxEnv] from a transaction, its sender, and encoded transaction bytes.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> MaybeCompact for T

§

impl<T> NonStaticAny for T
where T: ?Sized,

§

fn type_id(&self) -> TypeId

Returns the lifetime-erased type ID of self.
§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [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,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [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>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
§

impl<T> Paint for T
where T: ?Sized,

§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
§

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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
§

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);
§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more
§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> Threaded<T> for T

§

type Rest = ()

The outputs beyond the threaded value.
§

fn split(self) -> (T, ())

Splits into the threaded value and the extra outputs.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryClone for T
where T: Clone,

§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

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.