Skip to main content

SymbolicExecutor

foundry_evm_symbolic

Struct SymbolicExecutor 

Source 
pub struct SymbolicExecutor {
    pub(crate) config: SymbolicConfig,
    pub(crate) solver: Box<dyn SymbolicSolver>,
}
Expand description

SMT-LIB-backed symbolic executor.

This executor is intentionally separate from the concrete revm executor used by Foundry. It consumes bytecode and state from an existing [Executor], explores symbolic branches, and returns either a proof result, a counterexample candidate, or an incomplete result.

Fields§

§config: SymbolicConfig§solver: Box<dyn SymbolicSolver>

Implementations§

Source§

impl SymbolicExecutor

Source

pub(super) fn call( &mut self, executor: &Executor<impl FoundryEvmNetwork>, state: &mut PathState, worklist: &mut VecDeque<PathState>, completed_paths: &mut usize, kind: CallKind, ) -> Result<StepOutcome, SymbolicError>

Implements the call symbolic executor helper.

Source

pub(super) fn branch_symbolic_call_value_if_needed( &mut self, state: &mut PathState, worklist: &mut VecDeque<PathState>, pre_call_state: &PathState, call_pc: usize, to: Address, code_address: Address, value: &SymWord, gas: &SymWord, call_input: &[SymWord], ) -> Result<bool, SymbolicError>

Implements the branch_symbolic_call_value_if_needed symbolic executor helper.

Source

pub(super) fn branch_symbolic_function_mock_if_needed( &mut self, state: &mut PathState, worklist: &mut VecDeque<PathState>, pre_call_state: &PathState, call_pc: usize, callee: Address, calldata: &[SymWord], ) -> Result<bool, SymbolicError>

Implements the branch_symbolic_function_mock_if_needed symbolic executor helper.

Source

pub(super) fn observe_expected_call( &mut self, state: &mut PathState, callee: Address, value: Option<U256>, gas: &SymWord, calldata: &[SymWord], ) -> Result<bool, SymbolicError>

Applies the observe_expected_call symbolic executor helper.

Source

pub(super) fn branch_symbolic_call_match_if_needed( &mut self, state: &mut PathState, worklist: &mut VecDeque<PathState>, pre_call_state: &PathState, call_pc: usize, callee: Address, code_address: Address, value: Option<U256>, gas: &SymWord, calldata: &[SymWord], ) -> Result<bool, SymbolicError>

Implements the branch_symbolic_call_match_if_needed symbolic executor helper.

Source

pub(super) fn take_call_mock( &mut self, state: &mut PathState, callee: Address, value: Option<U256>, calldata: &[SymWord], ) -> Result<Option<CallMockOutcome>, SymbolicError>

Implements the take_call_mock symbolic executor helper.

Source

pub(super) fn branch_symbolic_match_condition_if_needed( &mut self, state: &mut PathState, worklist: &mut VecDeque<PathState>, pre_call_state: &PathState, call_pc: usize, condition: BoolExpr, ) -> Result<bool, SymbolicError>

Implements the branch_symbolic_match_condition_if_needed symbolic executor helper.

Source

pub(super) fn function_mock_target( &mut self, state: &mut PathState, callee: Address, calldata: &[SymWord], ) -> Result<Option<Address>, SymbolicError>

Implements the function_mock_target symbolic executor helper.

Source

pub(super) fn expected_call_match_constraints( &mut self, state: &PathState, expected: &ExpectedCall, callee: Address, value: Option<U256>, gas: &SymWord, calldata: &[SymWord], ) -> Result<Option<Vec<BoolExpr>>, SymbolicError>

Implements the expected_call_match_constraints symbolic executor helper.

Source

pub(super) fn call_mock_match_constraints( &mut self, state: &PathState, mock: &CallMock, callee: Address, value: Option<U256>, calldata: &[SymWord], ) -> Result<Option<Vec<BoolExpr>>, SymbolicError>

Implements the call_mock_match_constraints symbolic executor helper.

Source

pub(super) fn expected_call_match_condition( &self, expected: &ExpectedCall, callee: Address, value: Option<U256>, gas: &SymWord, calldata: &[SymWord], ) -> Result<Option<BoolExpr>, SymbolicError>

Implements the expected_call_match_condition symbolic executor helper.

Source

pub(super) fn call_mock_match_condition( &self, mock: &CallMock, callee: Address, value: Option<U256>, calldata: &[SymWord], ) -> Result<Option<BoolExpr>, SymbolicError>

Implements the call_mock_match_condition symbolic executor helper.

Source

pub(super) fn expected_revert_matches( &mut self, state: &mut PathState, expected: &ExpectedRevert, reverter: Address, return_data: &SymReturnData, ) -> Result<bool, SymbolicError>

Returns whether expected_revert_matches holds.

Source

pub(super) fn assume_no_revert_rejects( &mut self, state: &mut PathState, assumption: &AssumeNoRevert, reverter: Address, return_data: &SymReturnData, ) -> Result<bool, SymbolicError>

Implements the assume_no_revert_rejects symbolic executor helper.

Source

pub(super) fn constraints_for_condition( &mut self, state: &PathState, condition: BoolExpr, ) -> Result<Option<Vec<BoolExpr>>, SymbolicError>

Implements the constraints_for_condition symbolic executor helper.

Source

pub(super) fn constraints_with_condition( &mut self, state: &PathState, condition: BoolExpr, ) -> Result<(Vec<BoolExpr>, bool), SymbolicError>

Implements the constraints_with_condition symbolic executor helper.

Source

pub(super) fn take_loop_jump( &self, state: &mut PathState, source_pc: usize, dest: usize, ) -> bool

Implements the take_loop_jump symbolic executor helper.

Source

pub(super) fn handle_log( &mut self, state: &mut PathState, log: SymbolicLog, ) -> Result<StepOutcome, SymbolicError>

Runs the handle_log symbolic executor helper.

Source

pub(super) fn expected_emit_matches( &mut self, state: &mut PathState, expected: &ExpectedEmit, template: &SymbolicLog, actual: &SymbolicLog, ) -> Result<bool, SymbolicError>

Returns whether expected_emit_matches holds.

Source

pub(super) fn call_concrete_target<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: &mut PathState, worklist: &mut VecDeque<PathState>, completed_paths: &mut usize, kind: CallKind, to: Address, target_word: Option<SymWord>, value: SymWord, gas: SymWord, in_offset: SymWord, in_size: BoundedCopySize, out_offset: SymWord, out_size: BoundedCopySize, ) -> Result<StepOutcome, SymbolicError>

Implements the call_concrete_target symbolic executor helper.

Source

pub(super) fn prepare_value_transfer<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: &mut PathState, worklist: &mut VecDeque<PathState>, value: SymWord, out_offset: SymWord, out_size: &BoundedCopySize, ) -> Result<bool, SymbolicError>

Implements the prepare_value_transfer symbolic executor helper.

Source

pub(super) fn prepare_create_value_transfer<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: &mut PathState, worklist: &mut VecDeque<PathState>, value: SymWord, ) -> Result<bool, SymbolicError>

Implements the prepare_create_value_transfer symbolic executor helper.

Source

pub(super) fn call_symbolic_target<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: &mut PathState, worklist: &mut VecDeque<PathState>, completed_paths: &mut usize, kind: CallKind, target: SymWord, value: SymWord, gas: SymWord, in_offset: SymWord, in_size: BoundedCopySize, out_offset: SymWord, out_size: BoundedCopySize, ) -> Result<StepOutcome, SymbolicError>

Implements the call_symbolic_target symbolic executor helper.

Source§

impl SymbolicExecutor

Source

pub(super) fn handle_assertion( &mut self, state: &mut PathState, pass: BoolExpr, ) -> Result<CheatcodeOutcome, SymbolicError>

Runs the handle_assertion symbolic executor helper.

Source

pub(super) fn set_expected_revert( &mut self, state: &mut PathState, data: ExpectedRevertData, reverter: Option<SymWord>, remaining: u64, ) -> CheatcodeOutcome

Applies the set_expected_revert symbolic executor helper.

Source

pub(super) fn set_expected_emit( &mut self, state: &mut PathState, checks: ExpectedEmitChecks, emitter: Option<SymWord>, remaining: u64, ) -> CheatcodeOutcome

Applies the set_expected_emit symbolic executor helper.

Source

pub(super) fn set_expected_call( &mut self, state: &mut PathState, callee: SymWord, value: Option<U256>, gas: Option<u64>, min_gas: Option<u64>, data: Vec<SymWord>, count: Option<u64>, ) -> CheatcodeOutcome

Applies the set_expected_call symbolic executor helper.

Source

pub(super) fn set_expected_create( &mut self, state: &mut PathState, bytecode: Vec<u8>, deployer: SymWord, kind: CreateKind, ) -> CheatcodeOutcome

Applies the set_expected_create symbolic executor helper.

Source

pub(super) fn observe_expected_create( &mut self, state: &mut PathState, deployer: Address, kind: CreateKind, runtime: &SymReturnData, ) -> Result<(), SymbolicError>

Applies the observe_expected_create symbolic executor helper.

Source

pub(super) fn branch_accesses_cheatcode_if_needed( &mut self, state: &mut PathState, worklist: &mut VecDeque<PathState>, selector: [u8; 4], in_offset: usize, out_offset: SymWord, out_size: &BoundedCopySize, ) -> Result<Option<StepOutcome>, SymbolicError>

Implements the branch_accesses_cheatcode_if_needed symbolic executor helper.

Source

pub(super) fn accesses_return_data_for_target( &mut self, state: &mut PathState, target: SymWord, ) -> Result<SymReturnData, SymbolicError>

Implements the accesses_return_data_for_target symbolic executor helper.

Source

pub(super) fn add_call_mock( &mut self, state: &mut PathState, callee: SymWord, value: Option<U256>, data: Vec<SymWord>, returns: Vec<SymReturnData>, reverts: bool, ) -> CheatcodeOutcome

Implements the add_call_mock symbolic executor helper.

Source

pub(super) fn set_function_mock( &mut self, state: &mut PathState, callee: SymWord, target: Address, data: Vec<SymWord>, ) -> CheatcodeOutcome

Applies the set_function_mock symbolic executor helper.

Source

pub(super) fn handle_foundry_cheatcode<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: &mut PathState, selector: [u8; 4], in_offset: usize, in_size: usize, ) -> Result<CheatcodeOutcome, SymbolicError>

Runs the handle_foundry_cheatcode symbolic executor helper.

Source

pub(super) fn handle_symbolic_vm_cheatcode( &mut self, state: &mut PathState, selector: [u8; 4], in_offset: usize, ) -> Result<SymReturnData, SymbolicError>

Runs the handle_symbolic_vm_cheatcode symbolic executor helper.

Source§

impl SymbolicExecutor

Source

pub(super) fn handle_assume( &mut self, state: &mut PathState, condition_offset: usize, ) -> Result<CheatcodeOutcome, SymbolicError>

Runs the handle_assume symbolic executor helper.

Source

pub(super) fn handle_skip( &mut self, state: &mut PathState, condition_offset: usize, ) -> Result<CheatcodeOutcome, SymbolicError>

Runs the handle_skip symbolic executor helper.

Source

pub(super) fn assume_condition( &mut self, state: &mut PathState, condition: BoolExpr, ) -> Result<CheatcodeOutcome, SymbolicError>

Implements the assume_condition symbolic executor helper.

Source

pub(super) fn solver_upper_bound_usize( &mut self, state: &PathState, word: &SymWord, max: usize, reason: &'static str, ) -> Result<usize, SymbolicError>

Implements the solver_upper_bound_usize symbolic executor helper.

Source

pub(super) fn assume_word_at_least( &mut self, state: &mut PathState, word: &SymWord, min: usize, ) -> Result<bool, SymbolicError>

Implements the assume_word_at_least symbolic executor helper.

Source

pub(super) fn validate_symbolic_integer_bits( bits: U256, context: &'static str, ) -> Result<(), SymbolicError>

Rejects symbolic integer bit widths outside the EVM word size.

Source

pub(super) fn handle_bound_uint( &mut self, state: &mut PathState, args_offset: usize, ) -> Result<CheatcodeOutcome, SymbolicError>

Runs the handle_bound_uint symbolic executor helper.

Source

pub(super) fn handle_bound_int( &mut self, state: &mut PathState, args_offset: usize, ) -> Result<CheatcodeOutcome, SymbolicError>

Runs the handle_bound_int symbolic executor helper.

Source§

impl SymbolicExecutor

Source

pub(super) fn create<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: &mut PathState, worklist: &mut VecDeque<PathState>, completed_paths: &mut usize, kind: CreateKind, ) -> Result<StepOutcome, SymbolicError>

Implements the create symbolic executor helper.

Source

pub(super) fn execute_external_call<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, initial: PathState, code: &SymCode, completed_paths: &mut usize, ) -> Result<Vec<ExternalCallOutcome>, SymbolicError>

Computes the execute_external_call symbolic executor helper result.

Source§

impl SymbolicExecutor

Source

pub(super) fn execute_invariant_check<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: PathState, invariant_address: Address, sender: Address, invariant: &Function, after_invariant: Option<&Function>, completed_paths: &mut usize, ) -> Result<Vec<InvariantCheckOutcome>, SymbolicError>

Computes the execute_invariant_check symbolic executor helper result.

Source

pub(super) fn invariant_return_failed( &mut self, invariant: &Function, return_data: &SymReturnData, state: &mut PathState, ) -> Result<bool, SymbolicError>

Implements the invariant_return_failed symbolic executor helper.

Source

pub(super) fn execute_sequence_call<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, state: PathState, target: Address, sender: Address, _function: &Function, calldata: SymCalldata, constraints: Vec<BoolExpr>, completed_paths: &mut usize, ) -> Result<Vec<TopLevelCallOutcome>, SymbolicError>

Computes the execute_sequence_call symbolic executor helper result.

Source

pub(super) fn materialize_sequence( &mut self, steps: &[SequenceStepTemplate], state: &PathState, ) -> Result<Vec<SymbolicInvariantStep>, SymbolicError>

Runs the materialize_sequence symbolic executor helper.

Source§

impl SymbolicExecutor

Source

pub(super) fn step<FEN: FoundryEvmNetwork>( &mut self, executor: &Executor<FEN>, code: &SymCode, jumpdests: &BTreeSet<usize>, state: &mut PathState, worklist: &mut VecDeque<PathState>, completed_paths: &mut usize, op: u8, ) -> Result<StepOutcome, SymbolicError>

Runs the step symbolic executor helper.

Source

pub(super) fn assume_returndata_copy_in_bounds( &mut self, state: &mut PathState, offset: SymWord, size: SymWord, ) -> Result<bool, SymbolicError>

Implements the assume_returndata_copy_in_bounds symbolic executor helper.

Source

pub(super) fn return_or_revert( &mut self, state: &mut PathState, is_revert: bool, ) -> Result<StepOutcome, SymbolicError>

Implements the return_or_revert symbolic executor helper.

Source

pub(super) fn classify_revert( &self, state: &PathState, offset: SymWord, size: usize, ) -> StepOutcome

Runs the classify_revert symbolic executor helper.

Source§

impl SymbolicExecutor

Source

pub fn new(config: SymbolicConfig) -> Self

Creates a symbolic executor from Foundry’s symbolic configuration.

The configured solver command is not executed here. Solver availability is checked by Self::run so construction remains cheap and side-effect free.

The executor owns an isolated solver backend and symbolic world overlay. Create a fresh executor when a caller needs independent solver query accounting.

Source

pub fn portfolio_diagnostics(&self) -> Option<PortfolioDiagnostics>

Returns staged solver portfolio diagnostics collected by this executor.

Source

pub fn capture_diagnostics(&mut self)

Defers verbose solver diagnostics until the caller explicitly takes them.

Source

pub fn take_diagnostics(&mut self) -> Option<String>

Returns and clears deferred verbose solver diagnostics.

Source

pub fn set_query_observer( &mut self, observer: impl Fn(usize) + Send + Sync + 'static, )

Registers a callback invoked after each solver query for live progress rendering.

Source

pub fn run<FEN: FoundryEvmNetwork>( &mut self, input: SymbolicRunInput<'_, FEN>, ) -> SymbolicRunResult

Executes one function symbolically against an already-deployed test contract.

The input executor supplies the deployed bytecode, storage backend, caller, and target address established by the normal forge test setup flow. This method does not mutate the concrete executor and does not replay failures itself; when it returns SymbolicRunResult::Counterexample, callers should replay the returned arguments through the concrete executor before reporting the failure.

Unsupported opcodes, unsupported ABI types, missing solver support, and resource limit exhaustion are reported as SymbolicRunResult::Incomplete.

Ordinary Solidity require reverts prune the current path. Assertion failures, forge-std assertion reverts, and DSTest failure signals are reported as counterexample candidates when the failing path is satisfiable.

Source

pub fn run_invariant<FEN: FoundryEvmNetwork>( &mut self, input: SymbolicInvariantRunInput<'_, FEN>, ) -> SymbolicInvariantRunResult

Executes a bounded symbolic invariant call sequence.

Each sequence step chooses from the concrete target functions and senders supplied by Foundry’s invariant target discovery. Arguments are generated through the same symbolic ABI model used by stateless symbolic tests, and the symbolic world state is preserved between steps. Returned counterexamples must still be replayed by the caller before reporting.

The configured invariant depth limits the number of target calls explored before the invariant is checked. A depth of zero checks only the invariant against setup state.

Source

pub(super) fn run_inner<FEN: FoundryEvmNetwork>( &mut self, input: SymbolicRunInput<'_, FEN>, ) -> Result<SymbolicRunResult, SymbolicError>

Runs the run_inner symbolic executor helper.

Source

pub(super) fn materialize_stateless_counterexample( &mut self, calldata: &SymbolicCalldata, function: &Function, state: &PathState, ) -> Result<(Vec<DynSolValue>, Bytes), SymbolicError>

Runs the materialize_stateless_counterexample symbolic executor helper.

Source

pub(super) fn run_invariant_inner<FEN: FoundryEvmNetwork>( &mut self, input: SymbolicInvariantRunInput<'_, FEN>, ) -> Result<SymbolicInvariantRunResult, SymbolicError>

Runs the run_invariant_inner symbolic executor helper.

Source

pub(super) fn stats_with_paths(&self, paths: usize) -> SymbolicStats

Implements the stats_with_paths symbolic executor helper.

Source

fn heuristic_witnesses_used_since(&self, baseline: usize) -> bool

Returns whether this run used a hard-arithmetic heuristic witness.

Source

fn hard_arith_heuristic_incomplete_reason() -> String

Returns the incomplete reason used when heuristic witnesses cannot certify safety.

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,

§

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
§

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<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> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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: 256 bytes