Skip to main content

InspectorStackInner

Struct InspectorStackInner 

Source
pub struct InspectorStackInner {
Show 48 fields pub analysis: Option<Analysis>, pub chisel_state: Option<Box<ChiselState>>, pub debug_recorder: Option<Box<DebugRecorder>>, pub edge_coverage: Option<Box<EdgeCovInspector>>, pub fuzzer: Option<Box<Fuzzer>>, pub line_coverage: Option<Box<LineCoverageCollector>>, pub log_collector: Option<Box<LogCollector>>, pub printer: Option<Box<CustomPrintTracer>>, pub revert_diag: Option<Box<RevertDiagnostic>>, pub script_execution_inspector: Option<Box<ScriptExecutionInspector>>, pub tempo_labels: Option<Box<TempoLabels>>, pub tracer: Option<Box<TracingInspector>>, pub sancov_edges: bool, pub sancov_trace_cmp: bool, pub edgecov_opcode: bool, pub instrumented_edges: bool, pub instrumented_cmp_log: bool, pub enable_isolation: bool, pub fork_prefetch: bool, pub extra_cheatcode_addresses: &'static [Address], pub create2_deployer: Address, pub in_inner_context: bool, inner_root_depth: Option<u16>, pending_inner_root: Option<InnerRoot>, synthetic_create_depth: Option<u16>, isolated_source_fork: Option<(Option<U256>, Option<u64>)>, isolated_switch_warmth: Option<(PrewarmSet, AddressMap<HashSet<U256>>)>, env_handoff_ended: bool, tx_created: AddressMap<HashSet<Option<U256>>>, executed_destructs: Option<AddressMap<DestructedAccount>>, pub reverter: Option<Address>, pending_call_traces: Vec<PendingCallTrace>, pending_create2_error: Option<Bytes>, pub batch_create_counter: u64, pub batch_rewrite_warned: bool, pub batch_rewrite_process_salt: Option<u64>, execution_cancellation: Option<EvmExecutionCancellation>, cancellation_poll_counter: u8, execution_cancelled: bool, has_static_step_inspectors: bool, has_static_step_end_inspectors: bool, cheat_steps: OpcodeSet, cheat_records_branches: bool, static_steps: OpcodeSet, static_end_steps: OpcodeSet, hooked_steps: OpcodeSet, stepped: u8, suspended_stepped: Vec<u8>,
}
Expand description

All used inspectors besides Cheatcodes.

See InspectorStack.

Fields§

§analysis: Option<Analysis>

Solar compiler instance, to grant syntactic and semantic analysis capabilities.

§chisel_state: Option<Box<ChiselState>>§debug_recorder: Option<Box<DebugRecorder>>§edge_coverage: Option<Box<EdgeCovInspector>>§fuzzer: Option<Box<Fuzzer>>§line_coverage: Option<Box<LineCoverageCollector>>§log_collector: Option<Box<LogCollector>>§printer: Option<Box<CustomPrintTracer>>§revert_diag: Option<Box<RevertDiagnostic>>§script_execution_inspector: Option<Box<ScriptExecutionInspector>>§tempo_labels: Option<Box<TempoLabels>>§tracer: Option<Box<TracingInspector>>§sancov_edges: bool

Whether to collect sancov edge coverage from instrumented native crates.

§sancov_trace_cmp: bool

Whether to capture sancov trace-cmp operands for dictionary injection.

§edgecov_opcode: bool

Whether the EVM executes the compiler-instrumented EDGECOV and CMPLOG opcodes, which are undefined otherwise.

§instrumented_edges: bool

Whether to collect EDGECOV hits as the call’s edge coverage.

§instrumented_cmp_log: bool

Whether to collect comparison operands from CMPLOG probes instead of the cmp-log inspector.

§enable_isolation: bool§fork_prefetch: bool

Whether calls into fork contracts prefetch the remote state they are about to read, see Backend::prefetch_call.

§extra_cheatcode_addresses: &'static [Address]

Additional addresses installed and recognized as cheatcode contracts.

§create2_deployer: Address§in_inner_context: bool

Flag marking if we are in a nested transaction duplicating a frame of the running one.

§inner_root_depth: Option<u16>

Depth of the frame the running nested transaction duplicates.

§pending_inner_root: Option<InnerRoot>

The root frame of the nested transaction about to start.

§synthetic_create_depth: Option<u16>

Synthetic CREATE depth corresponding to an outer top-level deployment.

§isolated_source_fork: Option<(Option<U256>, Option<u64>)>

Active fork and cheatcode fork epoch when the running isolated call started.

§isolated_switch_warmth: Option<(PrewarmSet, AddressMap<HashSet<U256>>)>

Warmth of the running isolated call when it succeeded after switching forks, even back to the one it started on, captured before its transaction ended: its whole warm set, and the accounts and slots it accessed or fork switches carried, without its transaction’s base.

§env_handoff_ended: bool

Whether the frame that just ended ran on a frame EVM with an in-flight environment change, whose hooks already ran there. See InspectorStackRefMut::env_handoff.

§tx_created: AddressMap<HashSet<Option<U256>>>

Accounts the running top-level transaction created, directly or through isolated calls, with the forks it created them on.

§executed_destructs: Option<AddressMap<DestructedAccount>>

Accounts the running nested transaction, from executeTransaction or an isolated call, self-destructed, including the ones it created. Captured when its root frame ends, before the transaction destroys them. An isolated call that replaces the running state, such as by switching forks, still destroys them at once.

§reverter: Option<Address>

Address that reverted the call, if any.

§pending_call_traces: Vec<PendingCallTrace>

LIFO stack tracking the effective address of traced calls delegated to the EVM provider.

§pending_create2_error: Option<Bytes>

Pending CREATE2 deployer validation error, returned after the create hooks of the other inspectors so the trace stays balanced.

§batch_create_counter: u64

Counter for CREATE2 salt in --batch CREATE rewrites.

§batch_rewrite_warned: bool

Whether the one-shot --batch rewrite warning has already been emitted.

§batch_rewrite_process_salt: Option<u64>

Per-inspector random seed mixed into --batch CREATE2 salts, ensuring re-runs at identical on-chain state still produce distinct salts. Lazily initialized.

§execution_cancellation: Option<EvmExecutionCancellation>

Shared cancellation state for interruptible EVM execution.

§cancellation_poll_counter: u8

Counts cancellation polls; the deadline is read once every DEADLINE_POLL_INTERVAL.

§execution_cancelled: bool

Whether this inspector halted the current execution due to cancellation.

§has_static_step_inspectors: bool§has_static_step_end_inspectors: bool§cheat_steps: OpcodeSet

The opcodes the cheatcode step hooks run at, see Cheatcodes::hook_steps. Refreshed where evm2 reads the inspector config again, when a frame starts and when a message returns into it, since only cheatcode calls change it.

§cheat_records_branches: bool

Whether the cheatcodes step JUMPI only to record it, see Cheatcodes::record_branch.

§static_steps: OpcodeSet

The opcodes the other step inspectors step, see Self::static_steps. Refreshed with Self::cheat_steps.

§static_end_steps: OpcodeSet

The opcodes of Self::static_steps that an inspector with a step_end hook steps.

§hooked_steps: OpcodeSet

The opcodes at which a step hook runs: every stepped opcode but the ones that only poll the cancellation. Refreshed with Self::cheat_steps.

§stepped: u8

Which hooks stepped the running instruction, as STEPPED_STATIC and STEPPED_CHEAT.

§suspended_stepped: Vec<u8>

Self::stepped of the instruction that made each message in flight. The frames of a message overwrite Self::stepped, and the instruction’s step_end must run the static hooks only if its step ran them.

Implementations§

Source§

impl InspectorStackInner

Source

const fn refresh_static_opcode_dispatch(&mut self)

Source

const fn refresh_static_step_dispatch(&mut self)

Source

const fn refresh_static_step_end_dispatch(&mut self)

Source

fn static_steps<FEN: FoundryEvmNetwork>(&self) -> (OpcodeSet, OpcodeSet)

Returns the union of the opcodes of every inspector the step hooks call besides the cheatcodes, and the part of it that the inspectors the step_end hook calls step. An inspector that does not declare its opcodes steps all of them.

Source

fn next_batch_create_salt(&mut self, chain_id: u64, nonce: u64) -> U256

Derive the next --batch CREATE2 salt and advance the per-batch counter. The per-inspector random seed is lazily initialized on first use.

Source

fn execute_on_frame_evm<FEN: FoundryEvmNetwork>( &mut self, cheatcodes: Option<&mut Cheatcodes<FEN>>, backend: &mut dyn CheatcodesBackend<FEN>, evm: &mut FoundryEvmFor<'_, FEN>, env: EvmEnvFor<FEN>, message: &mut MessageFor<FEN>, ) -> Result<MessageResultFor<FEN>, ExecutionError>

Executes message of the transaction evm is running on a separate frame EVM with env, observed by the whole stack, such as for deployCode or an in-flight spec change.

Source

fn is_inner_context_root(&self, depth: u16) -> bool

Whether this frame is the root of a nested transaction, duplicating a surrounding frame.

Source

const fn enter_inner_context( &mut self, root: InnerRoot, ) -> (bool, Option<u16>, Option<InnerRoot>)

Enters a nested transaction whose root frame duplicates a surrounding frame, returning the previous context to restore with Self::exit_inner_context.

Source

const fn exit_inner_context( &mut self, previous: (bool, Option<u16>, Option<InnerRoot>), )

Restores the context saved by Self::enter_inner_context.

Source

fn replay<FEN: FoundryEvmNetwork>( &mut self, cheats: &mut Cheatcodes<FEN>, backend: &mut dyn CheatcodesBackend<FEN>, evm: &mut FoundryEvmFor<'_, FEN>, depth: u16, prepared: PreparedTx<TypesFor<FEN>>, untracked: bool, ) -> Result<ExecutedNested<TypesFor<FEN>>>

Executes a transaction replayed by the cheatcode call at depth, such as for vm.transact, observed by the whole stack with cheats active over the throwaway backend it was prepared with. Its root frame is a call below the cheatcode call.

Trait Implementations§

Source§

impl<FEN: FoundryEvmNetwork> CheatcodesExecutor<FEN> for InspectorStackInner

Source§

fn exec_message( &mut self, cheats: &mut Cheatcodes<FEN>, backend: &mut dyn CheatcodesBackend<FEN>, evm: &mut FoundryEvmFor<'_, FEN>, message: &mut MessageFor<FEN>, ) -> Result<MessageResultFor<FEN>, ExecutionError>

Executes message as a nested frame of the transaction evm is running, with cheats active, such as for deployCode or storage-hook callbacks.
Source§

fn nested_transaction( &mut self, cheats: &mut Cheatcodes<FEN>, backend: &mut dyn CheatcodesBackend<FEN>, evm: &mut FoundryEvmFor<'_, FEN>, depth: u16, tx: &Recovered<TxFor<FEN>>, env: Option<EvmEnvFor<FEN>>, ) -> Result<TxResultFor<FEN>>

Executes tx as a nested transaction of the transaction evm is running, with env or the running environment, and merges its changes so that they survive reverts of the enclosing calls, such as for executeTransaction. A failed transaction only keeps its nonce increment. Read more
Source§

fn transact( &mut self, cheats: &mut Cheatcodes<FEN>, backend: &mut dyn CheatcodesBackend<FEN>, evm: &mut FoundryEvmFor<'_, FEN>, depth: u16, fork_id: Option<U256>, transaction: B256, ) -> Result<TxResultFor<FEN>>

Replays a mined transaction of fork fork_id, or of the active fork, for vm.transact. Read more
Source§

fn transact_from_tx( &mut self, cheats: &mut Cheatcodes<FEN>, backend: &mut dyn CheatcodesBackend<FEN>, evm: &mut FoundryEvmFor<'_, FEN>, depth: u16, tx: &Recovered<TxFor<FEN>>, env: Option<EvmEnvFor<FEN>>, ) -> Result<TxResultFor<FEN>>

Executes a signed transaction as a nested transaction, such as for broadcastRawTransaction. Read more
Source§

fn console_log(&mut self, msg: &str)

Simulates console.log invocation.
Source§

fn tracing_inspector(&mut self) -> Option<&mut TracingInspector>

Returns a mutable reference to the tracing inspector if it is available.
Source§

impl Clone for InspectorStackInner

Source§

fn clone(&self) -> Self

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 Debug for InspectorStackInner

Source§

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

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

impl Default for InspectorStackInner

Source§

fn default() -> Self

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

Auto Trait Implementations§

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<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: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 824 bytes