pub struct InspectorStack<FEN = EthEvmNetwork>where
FEN: FoundryEvmNetwork,{
pub cheatcodes: Option<Box<Cheatcodes<FEN>>>,
pub inner: InspectorStackInner,
}Expand description
An inspector that calls multiple inspectors in sequence.
If a call to an inspector returns a value (indicating a stop or revert) the remaining inspectors are not called.
Stack is divided into Cheatcodes and InspectorStackInner. This is done to allow assembling
InspectorStackRefMut inside Cheatcodes to allow usage of it as an evm2 [Inspector].
This gives us ability to create and execute separate EVM frames from inside cheatcodes while
still having access to entire stack of inspectors and correctly handling traces, logs,
debugging info collection, etc.
The stack observes an execution through InspectorStack::as_inspector, which pairs it with
the backend the execution runs over.
Fields§
§cheatcodes: Option<Box<Cheatcodes<FEN>>>§inner: InspectorStackInnerImplementations§
Source§impl<FEN> InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
impl<FEN> InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
Sourcepub fn new() -> InspectorStack<FEN>
pub fn new() -> InspectorStack<FEN>
Creates a new inspector stack.
Note that the stack is empty by default, and you must add inspectors to it.
This is done by calling the set_* methods on the stack directly, or by building the stack
with InspectorStack.
Sourcepub fn set_analysis(&mut self, analysis: Arc<Compiler>)
pub fn set_analysis(&mut self, analysis: Arc<Compiler>)
Set the solar compiler instance.
Sourcepub fn set_execution_deadline(
&mut self,
early_exit: EarlyExit,
deadline: Instant,
)
pub fn set_execution_deadline( &mut self, early_exit: EarlyExit, deadline: Instant, )
Stops EVM execution at deadline, or earlier on the process-wide early-exit signal.
Sourcepub fn set_block(
&mut self,
block: BlockEnvExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::BlockEnvExt>,
)
pub fn set_block( &mut self, block: BlockEnvExt<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::BlockEnvExt>, )
Sets the block for the relevant inspectors.
Sourcepub fn set_gas_price(&mut self, gas_price: u128)
pub fn set_gas_price(&mut self, gas_price: u128)
Sets the gas price for the relevant inspectors.
Sourcepub fn set_cheatcodes(&mut self, cheatcodes: Cheatcodes<FEN>)
pub fn set_cheatcodes(&mut self, cheatcodes: Cheatcodes<FEN>)
Set the cheatcodes inspector.
Sourcepub fn set_fuzzer(&mut self, fuzzer: Fuzzer)
pub fn set_fuzzer(&mut self, fuzzer: Fuzzer)
Set the fuzzer inspector.
Sourcepub fn set_chisel(&mut self, chisel: ChiselState)
pub fn set_chisel(&mut self, chisel: ChiselState)
Set the Chisel inspector.
Sourcepub fn collect_line_coverage(&mut self, yes: bool)
pub fn collect_line_coverage(&mut self, yes: bool)
Set whether to enable the line coverage collector.
Sourcepub fn collect_edge_coverage(&mut self, yes: bool)
pub fn collect_edge_coverage(&mut self, yes: bool)
Set whether to enable the edge coverage collector with default config.
Sourcepub fn collect_edge_coverage_with_edge_config(&mut self, config: EdgeCovConfig)
pub fn collect_edge_coverage_with_edge_config(&mut self, config: EdgeCovConfig)
Enable edge coverage with an explicit configuration.
Sourcepub fn collect_edge_coverage_with_config(&mut self, corpus: &FuzzCorpusConfig)
pub fn collect_edge_coverage_with_config(&mut self, corpus: &FuzzCorpusConfig)
Configure the edge coverage collector from a FuzzCorpusConfig.
Derives both the on/off gate and EdgeCovConfig from corpus.
Sourcepub const fn enable_edgecov_opcode(&mut self, yes: bool)
pub const fn enable_edgecov_opcode(&mut self, yes: bool)
Set whether the EVM executes the compiler-instrumented EDGECOV and CMPLOG opcodes, so
that instrumented code also runs outside coverage-guided campaigns.
Sourcepub fn disable_fuzz_instrumentation(&mut self)
pub fn disable_fuzz_instrumentation(&mut self)
Drops the inspectors that only feed fuzz guidance: edge coverage, the fuzzer value collector, and sancov collection. Calls whose coverage and collected values are never merged back, such as invariant predicate checks, run faster without them.
Sourcepub fn collect_evm_cmp_log(&mut self, yes: bool)
pub fn collect_evm_cmp_log(&mut self, yes: bool)
Set whether to collect EVM comparison operands.
Sourcepub const fn collect_sancov_edges(&mut self, yes: bool)
pub const fn collect_sancov_edges(&mut self, yes: bool)
Set whether to collect sancov edge coverage from instrumented native crates.
Sourcepub const fn collect_sancov_trace_cmp(&mut self, yes: bool)
pub const fn collect_sancov_trace_cmp(&mut self, yes: bool)
Set whether to capture sancov trace-cmp operands for dictionary injection.
Sourcepub fn collect_failure_identity(&mut self, yes: bool)
pub fn collect_failure_identity(&mut self, yes: bool)
Set whether to record the failure identity of each call, see
RawCallResult::failure_identity.
Steps every instruction while set, so it is only meant for replays of a failure.
Sourcepub fn pause_failure_identity(&mut self, yes: bool)
pub fn pause_failure_identity(&mut self, yes: bool)
Set whether recording failure identities is paused, see Self::collect_failure_identity.
Calls made while paused still skip cheatcodes with effects outside the EVM, but do not step every instruction and have no identity.
Sourcepub fn take_skipped_host_effects(&self) -> bool
pub fn take_skipped_host_effects(&self) -> bool
Returns whether a call skipped a cheatcode with effects outside the EVM while recording failure identities, and clears it for the copies of this stack that share it.
Sourcepub fn collect_failure_provenance(&mut self, yes: bool)
pub fn collect_failure_provenance(&mut self, yes: bool)
Set whether to record the failure provenance of each call, see
RawCallResult::failure_provenance.
Only steps JUMPI, REVERT and INVALID and hashes the site of each call, so it can stay
set during campaigns.
Sourcepub const fn enable_isolation(&mut self, yes: bool)
pub const fn enable_isolation(&mut self, yes: bool)
Set whether to enable call isolation.
Sourcepub const fn fork_prefetch(&mut self, yes: bool)
pub const fn fork_prefetch(&mut self, yes: bool)
Set whether calls into fork contracts prefetch the remote state they are about to read.
Sourcepub const fn extra_cheatcode_addresses(&self) -> &'static [Address]
pub const fn extra_cheatcode_addresses(&self) -> &'static [Address]
Returns additional addresses installed and recognized as cheatcode contracts.
Sourcepub const fn set_extra_cheatcode_addresses(
&mut self,
addresses: &'static [Address],
)
pub const fn set_extra_cheatcode_addresses( &mut self, addresses: &'static [Address], )
Sets additional addresses installed and recognized as cheatcode contracts.
Sourcepub fn set_create2_deployer(&mut self, deployer: Address)
pub fn set_create2_deployer(&mut self, deployer: Address)
Set the CREATE2 deployer address.
Sourcepub fn collect_logs(&mut self, live_logs: Option<bool>)
pub fn collect_logs(&mut self, live_logs: Option<bool>)
Set whether to enable the log collector.
- None for no log collection.
- Some(true) for realtime console.log-ing.
- Some(false) for log collection.
Sourcepub fn tracing_requirements(&mut self, requirements: TraceRequirements)
pub fn tracing_requirements(&mut self, requirements: TraceRequirements)
Set trace data requirements.
Sourcepub fn set_tracer(&mut self, tracer: Option<Box<TracingInspector>>)
pub fn set_tracer(&mut self, tracer: Option<Box<TracingInspector>>)
Replaces the tracer, such as with one taken before changing the trace requirements. Revert diagnostics only annotate trace nodes, so they follow the tracer.
Sourcepub fn script(&mut self, script_address: Address)
pub fn script(&mut self, script_address: Address)
Set whether to enable script execution inspector.
Sourcepub fn as_inspector<'a>(
&'a mut self,
backend: &'a mut dyn CheatcodesBackend<FEN>,
) -> InspectorStackRefMut<'a, FEN>
pub fn as_inspector<'a>( &'a mut self, backend: &'a mut dyn CheatcodesBackend<FEN>, ) -> InspectorStackRefMut<'a, FEN>
Returns the stack as an evm2 inspector of an execution over backend.
Sourcepub fn collect(self) -> InspectorData<FEN>
pub fn collect(self) -> InspectorData<FEN>
Collects all the data gathered during inspection into a single struct.
Trait Implementations§
Source§impl<FEN> Clone for InspectorStack<FEN>where
FEN: Clone + FoundryEvmNetwork,
impl<FEN> Clone for InspectorStack<FEN>where
FEN: Clone + FoundryEvmNetwork,
Source§fn clone(&self) -> InspectorStack<FEN>
fn clone(&self) -> InspectorStack<FEN>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<FEN> Debug for InspectorStack<FEN>where
FEN: Debug + FoundryEvmNetwork,
impl<FEN> Debug for InspectorStack<FEN>where
FEN: Debug + FoundryEvmNetwork,
Source§impl<FEN> Default for InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
impl<FEN> Default for InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
Source§fn default() -> InspectorStack<FEN>
fn default() -> InspectorStack<FEN>
Source§impl<FEN> Deref for InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
impl<FEN> Deref for InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
Source§type Target = InspectorStackInner
type Target = InspectorStackInner
Source§impl<FEN> DerefMut for InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
impl<FEN> DerefMut for InspectorStack<FEN>where
FEN: FoundryEvmNetwork,
Auto Trait Implementations§
impl<FEN = EthEvmNetwork> !Freeze for InspectorStack<FEN>
impl<FEN = EthEvmNetwork> !RefUnwindSafe for InspectorStack<FEN>
impl<FEN = EthEvmNetwork> !UnwindSafe for InspectorStack<FEN>
impl<FEN> Send for InspectorStack<FEN>
impl<FEN> Sync for InspectorStack<FEN>
impl<FEN> Unpin for InspectorStack<FEN>
impl<FEN> UnsafeUnpin for InspectorStack<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: 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: 832 bytes