Struct Evm
pub struct Evm<CTX, INSP, I, P> {
pub ctx: CTX,
pub inspector: INSP,
pub instruction: I,
pub precompiles: P,
}
Expand description
Main EVM structure that contains all data needed for execution.
Fields§
§ctx: CTX
context_interface::ContextTr
of the EVM it is used to fetch data from database.
inspector: INSP
Inspector of the EVM it is used to inspect the EVM. Its trait are defined in revm-inspector crate.
instruction: I
Instructions provider of the EVM it is used to execute instructions.
InstructionProvider
trait is defined in revm-handler crate.
precompiles: P
Precompile provider of the EVM it is used to execute precompiles.
PrecompileProvider
trait is defined in revm-handler crate.
Implementations§
§impl<CTX, I, INSP, P> Evm<CTX, INSP, I, P>
impl<CTX, I, INSP, P> Evm<CTX, INSP, I, P>
pub fn new_with_inspector(
ctx: CTX,
inspector: INSP,
instruction: I,
precompiles: P,
) -> Evm<CTX, INSP, I, P>
pub fn new_with_inspector( ctx: CTX, inspector: INSP, instruction: I, precompiles: P, ) -> Evm<CTX, INSP, I, P>
Create a new EVM instance with a given context, inspector, instruction set, and precompile provider.
§impl<CTX, INSP, I, P> Evm<CTX, INSP, I, P>
impl<CTX, INSP, I, P> Evm<CTX, INSP, I, P>
pub fn with_inspector<OINSP>(self, inspector: OINSP) -> Evm<CTX, OINSP, I, P>
pub fn with_inspector<OINSP>(self, inspector: OINSP) -> Evm<CTX, OINSP, I, P>
Consumed self and returns new Evm type with given Inspector.
pub fn with_precompiles<OP>(self, precompiles: OP) -> Evm<CTX, INSP, I, OP>
pub fn with_precompiles<OP>(self, precompiles: OP) -> Evm<CTX, INSP, I, OP>
Consumes self and returns new Evm type with given Precompiles.
pub fn into_inspector(self) -> INSP
pub fn into_inspector(self) -> INSP
Consumes self and returns inner Inspector.
Trait Implementations§
§impl<CTX, INSP, I, P> EvmTr for Evm<CTX, INSP, I, P>where
CTX: ContextTr,
I: InstructionProvider<Context = CTX>,
<I as InstructionProvider>::InterpreterTypes: InterpreterTypes<Output = InterpreterAction>,
P: PrecompileProvider<CTX>,
impl<CTX, INSP, I, P> EvmTr for Evm<CTX, INSP, I, P>where
CTX: ContextTr,
I: InstructionProvider<Context = CTX>,
<I as InstructionProvider>::InterpreterTypes: InterpreterTypes<Output = InterpreterAction>,
P: PrecompileProvider<CTX>,
§type Instructions = I
type Instructions = I
§type Precompiles = P
type Precompiles = P
§fn run_interpreter(
&mut self,
interpreter: &mut Interpreter<<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes>,
) -> <<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes as InterpreterTypes>::Output
fn run_interpreter( &mut self, interpreter: &mut Interpreter<<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes>, ) -> <<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes as InterpreterTypes>::Output
§fn ctx(&mut self) -> &mut <Evm<CTX, INSP, I, P> as EvmTr>::Context
fn ctx(&mut self) -> &mut <Evm<CTX, INSP, I, P> as EvmTr>::Context
§fn ctx_ref(&self) -> &<Evm<CTX, INSP, I, P> as EvmTr>::Context
fn ctx_ref(&self) -> &<Evm<CTX, INSP, I, P> as EvmTr>::Context
§fn ctx_instructions(
&mut self,
) -> (&mut <Evm<CTX, INSP, I, P> as EvmTr>::Context, &mut <Evm<CTX, INSP, I, P> as EvmTr>::Instructions)
fn ctx_instructions( &mut self, ) -> (&mut <Evm<CTX, INSP, I, P> as EvmTr>::Context, &mut <Evm<CTX, INSP, I, P> as EvmTr>::Instructions)
§fn ctx_precompiles(
&mut self,
) -> (&mut <Evm<CTX, INSP, I, P> as EvmTr>::Context, &mut <Evm<CTX, INSP, I, P> as EvmTr>::Precompiles)
fn ctx_precompiles( &mut self, ) -> (&mut <Evm<CTX, INSP, I, P> as EvmTr>::Context, &mut <Evm<CTX, INSP, I, P> as EvmTr>::Precompiles)
§impl<CTX, INSP, INST, PRECOMPILES> ExecuteCommitEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
<CTX as ContextTr>::Db: DatabaseCommit,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
impl<CTX, INSP, INST, PRECOMPILES> ExecuteCommitEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
<CTX as ContextTr>::Db: DatabaseCommit,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
§type CommitOutput = Result<ExecutionResult, EVMError<<<CTX as ContextTr>::Db as Database>::Error>>
type CommitOutput = Result<ExecutionResult, EVMError<<<CTX as ContextTr>::Db as Database>::Error>>
§fn replay_commit(
&mut self,
) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteCommitEvm>::CommitOutput
fn replay_commit( &mut self, ) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteCommitEvm>::CommitOutput
§fn transact_commit(&mut self, tx: Self::Tx) -> Self::CommitOutput
fn transact_commit(&mut self, tx: Self::Tx) -> Self::CommitOutput
§impl<CTX, INSP, INST, PRECOMPILES> ExecuteEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
impl<CTX, INSP, INST, PRECOMPILES> ExecuteEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
§type Output = Result<ResultAndState, EVMError<<<CTX as ContextTr>::Db as Database>::Error>>
type Output = Result<ResultAndState, EVMError<<<CTX as ContextTr>::Db as Database>::Error>>
§fn replay(
&mut self,
) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Output
fn replay( &mut self, ) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Output
§fn set_tx(&mut self, tx: <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Tx)
fn set_tx(&mut self, tx: <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Tx)
§fn set_block(
&mut self,
block: <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Block,
)
fn set_block( &mut self, block: <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Block, )
§impl<CTX, INSP, INST, PRECOMPILES> InspectCommitEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextSetters + ContextTr,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput> + JournalExt,
<CTX as ContextTr>::Db: DatabaseCommit,
INSP: Inspector<CTX>,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
impl<CTX, INSP, INST, PRECOMPILES> InspectCommitEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextSetters + ContextTr,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput> + JournalExt,
<CTX as ContextTr>::Db: DatabaseCommit,
INSP: Inspector<CTX>,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
§fn inspect_replay_commit(
&mut self,
) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteCommitEvm>::CommitOutput
fn inspect_replay_commit( &mut self, ) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteCommitEvm>::CommitOutput
InspectEvm::inspect_replay
and commit the state diff to the database.§fn inspect_replay_commit_with_inspector(
&mut self,
inspector: Self::Inspector,
) -> Self::CommitOutput
fn inspect_replay_commit_with_inspector( &mut self, inspector: Self::Inspector, ) -> Self::CommitOutput
InspectEvm::inspect_replay_with_inspector
and commit the state diff to the database.§fn inspect_replay_with_inspector(
&mut self,
inspector: Self::Inspector,
) -> Self::CommitOutput
fn inspect_replay_with_inspector( &mut self, inspector: Self::Inspector, ) -> Self::CommitOutput
InspectEvm::inspect_replay_with_inspector
and commit the state diff to the database.§fn inspect_commit(
&mut self,
tx: Self::Tx,
inspector: Self::Inspector,
) -> Self::CommitOutput
fn inspect_commit( &mut self, tx: Self::Tx, inspector: Self::Inspector, ) -> Self::CommitOutput
InspectEvm::inspect
and commit the state diff to the database.§impl<CTX, INSP, INST, PRECOMPILES> InspectEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextSetters + ContextTr,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput> + JournalExt,
INSP: Inspector<CTX>,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
impl<CTX, INSP, INST, PRECOMPILES> InspectEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextSetters + ContextTr,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput> + JournalExt,
INSP: Inspector<CTX>,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
type Inspector = INSP
§fn set_inspector(
&mut self,
inspector: <Evm<CTX, INSP, INST, PRECOMPILES> as InspectEvm>::Inspector,
)
fn set_inspector( &mut self, inspector: <Evm<CTX, INSP, INST, PRECOMPILES> as InspectEvm>::Inspector, )
§fn inspect_replay(
&mut self,
) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Output
fn inspect_replay( &mut self, ) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Output
§fn inspect(&mut self, tx: Self::Tx, inspector: Self::Inspector) -> Self::Output
fn inspect(&mut self, tx: Self::Tx, inspector: Self::Inspector) -> Self::Output
§fn inspect_replay_with_inspector(
&mut self,
inspector: Self::Inspector,
) -> Self::Output
fn inspect_replay_with_inspector( &mut self, inspector: Self::Inspector, ) -> Self::Output
§fn inspect_with_tx(&mut self, tx: Self::Tx) -> Self::Output
fn inspect_with_tx(&mut self, tx: Self::Tx) -> Self::Output
§impl<CTX, INSP, I, P> InspectorEvmTr for Evm<CTX, INSP, I, P>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalExt,
I: InstructionProvider<Context = CTX>,
<I as InstructionProvider>::InterpreterTypes: InterpreterTypes<Output = InterpreterAction>,
P: PrecompileProvider<CTX>,
INSP: Inspector<CTX, <I as InstructionProvider>::InterpreterTypes>,
impl<CTX, INSP, I, P> InspectorEvmTr for Evm<CTX, INSP, I, P>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalExt,
I: InstructionProvider<Context = CTX>,
<I as InstructionProvider>::InterpreterTypes: InterpreterTypes<Output = InterpreterAction>,
P: PrecompileProvider<CTX>,
INSP: Inspector<CTX, <I as InstructionProvider>::InterpreterTypes>,
type Inspector = INSP
§fn inspector(
&mut self,
) -> &mut <Evm<CTX, INSP, I, P> as InspectorEvmTr>::Inspector
fn inspector( &mut self, ) -> &mut <Evm<CTX, INSP, I, P> as InspectorEvmTr>::Inspector
§fn ctx_inspector(
&mut self,
) -> (&mut <Evm<CTX, INSP, I, P> as EvmTr>::Context, &mut <Evm<CTX, INSP, I, P> as InspectorEvmTr>::Inspector)
fn ctx_inspector( &mut self, ) -> (&mut <Evm<CTX, INSP, I, P> as EvmTr>::Context, &mut <Evm<CTX, INSP, I, P> as InspectorEvmTr>::Inspector)
§fn run_inspect_interpreter(
&mut self,
interpreter: &mut Interpreter<<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes>,
) -> <<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes as InterpreterTypes>::Output
fn run_inspect_interpreter( &mut self, interpreter: &mut Interpreter<<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes>, ) -> <<<Evm<CTX, INSP, I, P> as EvmTr>::Instructions as InstructionProvider>::InterpreterTypes as InterpreterTypes>::Output
§impl<CTX, INSP, INST, PRECOMPILES> SystemCallCommitEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
<CTX as ContextTr>::Db: DatabaseCommit,
<CTX as ContextTr>::Tx: SystemCallTx,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
impl<CTX, INSP, INST, PRECOMPILES> SystemCallCommitEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
<CTX as ContextTr>::Db: DatabaseCommit,
<CTX as ContextTr>::Tx: SystemCallTx,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
§fn transact_system_call_commit(
&mut self,
system_contract_address: Address,
data: Bytes,
) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteCommitEvm>::CommitOutput
fn transact_system_call_commit( &mut self, system_contract_address: Address, data: Bytes, ) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteCommitEvm>::CommitOutput
§impl<CTX, INSP, INST, PRECOMPILES> SystemCallEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
<CTX as ContextTr>::Tx: SystemCallTx,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
impl<CTX, INSP, INST, PRECOMPILES> SystemCallEvm for Evm<CTX, INSP, INST, PRECOMPILES>where
CTX: ContextTr + ContextSetters,
<CTX as ContextTr>::Journal: JournalTr<FinalOutput = JournalOutput>,
<CTX as ContextTr>::Tx: SystemCallTx,
INST: InstructionProvider<Context = CTX, InterpreterTypes = EthInterpreter>,
PRECOMPILES: PrecompileProvider<CTX, Output = InterpreterResult>,
§fn transact_system_call(
&mut self,
system_contract_address: Address,
data: Bytes,
) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Output
fn transact_system_call( &mut self, system_contract_address: Address, data: Bytes, ) -> <Evm<CTX, INSP, INST, PRECOMPILES> as ExecuteEvm>::Output
Auto Trait Implementations§
impl<CTX, INSP, I, P> Freeze for Evm<CTX, INSP, I, P>
impl<CTX, INSP, I, P> RefUnwindSafe for Evm<CTX, INSP, I, P>
impl<CTX, INSP, I, P> Send for Evm<CTX, INSP, I, P>
impl<CTX, INSP, I, P> Sync for Evm<CTX, INSP, I, P>
impl<CTX, INSP, I, P> Unpin for Evm<CTX, INSP, I, P>
impl<CTX, INSP, I, P> UnwindSafe for Evm<CTX, INSP, I, P>
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
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> 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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> 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<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>
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,
Source§impl<R> Rng for R
impl<R> Rng for R
Source§fn random<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
fn random<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
StandardUniform
distribution. Read moreSource§fn random_iter<T>(self) -> Iter<StandardUniform, Self, T> ⓘ
fn random_iter<T>(self) -> Iter<StandardUniform, Self, T> ⓘ
Source§fn random_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
fn random_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
Source§fn random_bool(&mut self, p: f64) -> bool
fn random_bool(&mut self, p: f64) -> bool
p
of being true. Read moreSource§fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool
fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool
numerator/denominator
of being
true. Read moreSource§fn sample<T, D>(&mut self, distr: D) -> Twhere
D: Distribution<T>,
fn sample<T, D>(&mut self, distr: D) -> Twhere
D: Distribution<T>,
Source§fn sample_iter<T, D>(self, distr: D) -> Iter<D, Self, T> ⓘwhere
D: Distribution<T>,
Self: Sized,
fn sample_iter<T, D>(self, distr: D) -> Iter<D, Self, T> ⓘwhere
D: Distribution<T>,
Self: Sized,
Source§fn gen<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
fn gen<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
random
to avoid conflict with the new gen
keyword in Rust 2024.Rng::random
.Source§fn gen_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
fn gen_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
random_range
Rng::random_range
.§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> TryConv for T
impl<T> TryConv for T
Source§impl<R> TryRngCore for R
impl<R> TryRngCore for R
Source§type Error = Infallible
type Error = Infallible
Source§fn try_next_u32(&mut self) -> Result<u32, <R as TryRngCore>::Error>
fn try_next_u32(&mut self) -> Result<u32, <R as TryRngCore>::Error>
u32
.Source§fn try_next_u64(&mut self) -> Result<u64, <R as TryRngCore>::Error>
fn try_next_u64(&mut self) -> Result<u64, <R as TryRngCore>::Error>
u64
.Source§fn try_fill_bytes(
&mut self,
dst: &mut [u8],
) -> Result<(), <R as TryRngCore>::Error>
fn try_fill_bytes( &mut self, dst: &mut [u8], ) -> Result<(), <R as TryRngCore>::Error>
dest
entirely with random data.Source§fn unwrap_mut(&mut self) -> UnwrapMut<'_, Self>
fn unwrap_mut(&mut self) -> UnwrapMut<'_, Self>
UnwrapMut
wrapper.Source§fn read_adapter(&mut self) -> RngReadAdapter<'_, Self> ⓘwhere
Self: Sized,
fn read_adapter(&mut self) -> RngReadAdapter<'_, Self> ⓘwhere
Self: Sized,
RngCore
to a RngReadAdapter
.§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> ⓘ
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§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>,
Source§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
impl<T> CryptoRng for T
impl<T> Formattable for T
impl<T> Parsable for T
impl<R> TryCryptoRng for R
Layout§
Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.