Struct Interpreter
pub struct Interpreter<WIRE = EthInterpreter>where
WIRE: InterpreterTypes,{
pub bytecode: <WIRE as InterpreterTypes>::Bytecode,
pub gas: Gas,
pub stack: <WIRE as InterpreterTypes>::Stack,
pub return_data: <WIRE as InterpreterTypes>::ReturnData,
pub memory: <WIRE as InterpreterTypes>::Memory,
pub input: <WIRE as InterpreterTypes>::Input,
pub runtime_flag: <WIRE as InterpreterTypes>::RuntimeFlag,
pub extend: <WIRE as InterpreterTypes>::Extend,
}
evm
only.Expand description
Main interpreter structure that contains all components defined in InterpreterTypes
.
Fields§
§bytecode: <WIRE as InterpreterTypes>::Bytecode
Bytecode being executed.
gas: Gas
Gas tracking for execution costs.
stack: <WIRE as InterpreterTypes>::Stack
EVM stack for computation.
return_data: <WIRE as InterpreterTypes>::ReturnData
Buffer for return data from calls.
memory: <WIRE as InterpreterTypes>::Memory
EVM memory for data storage.
input: <WIRE as InterpreterTypes>::Input
Input data for current execution context.
runtime_flag: <WIRE as InterpreterTypes>::RuntimeFlag
Runtime flags controlling execution behavior.
extend: <WIRE as InterpreterTypes>::Extend
Extended functionality and customizations.
Implementations§
§impl<EXT> Interpreter<EthInterpreter<EXT>>where
EXT: Default,
impl<EXT> Interpreter<EthInterpreter<EXT>>where
EXT: Default,
pub fn new(
memory: SharedMemory,
bytecode: ExtBytecode,
input: InputsImpl,
is_static: bool,
spec_id: SpecId,
gas_limit: u64,
) -> Interpreter<EthInterpreter<EXT>>
pub fn new( memory: SharedMemory, bytecode: ExtBytecode, input: InputsImpl, is_static: bool, spec_id: SpecId, gas_limit: u64, ) -> Interpreter<EthInterpreter<EXT>>
Create new interpreter
pub fn default_ext() -> Interpreter<EthInterpreter<EXT>>
pub fn default_ext() -> Interpreter<EthInterpreter<EXT>>
Create a new interpreter with default extended functionality.
pub fn invalid() -> Interpreter<EthInterpreter<EXT>>
pub fn invalid() -> Interpreter<EthInterpreter<EXT>>
Create a new invalid interpreter.
pub fn clear(
&mut self,
memory: SharedMemory,
bytecode: ExtBytecode,
input: InputsImpl,
is_static: bool,
spec_id: SpecId,
gas_limit: u64,
)
pub fn clear( &mut self, memory: SharedMemory, bytecode: ExtBytecode, input: InputsImpl, is_static: bool, spec_id: SpecId, gas_limit: u64, )
Clears and reinitializes the interpreter with new parameters.
pub fn with_bytecode(
self,
bytecode: Bytecode,
) -> Interpreter<EthInterpreter<EXT>>
pub fn with_bytecode( self, bytecode: Bytecode, ) -> Interpreter<EthInterpreter<EXT>>
Sets the bytecode that is going to be executed
pub fn set_spec_id(&mut self, spec_id: SpecId)
pub fn set_spec_id(&mut self, spec_id: SpecId)
Sets the specid for the interpreter.
§impl<IW> Interpreter<IW>where
IW: InterpreterTypes,
impl<IW> Interpreter<IW>where
IW: InterpreterTypes,
pub fn resize_memory(&mut self, offset: usize, len: usize) -> bool
pub fn resize_memory(&mut self, offset: usize, len: usize) -> bool
Performs EVM memory resize.
pub fn take_next_action(&mut self) -> InterpreterAction
pub fn take_next_action(&mut self) -> InterpreterAction
Takes the next action from the control and returns it.
pub fn halt(&mut self, result: InstructionResult)
pub fn halt(&mut self, result: InstructionResult)
Halt the interpreter with the given result.
This will set the action to InterpreterAction::Return
and set the gas to the current gas.
pub fn halt_oog(&mut self)
pub fn halt_oog(&mut self)
Halt the interpreter with an out-of-gas error.
pub fn halt_memory_oog(&mut self)
pub fn halt_memory_oog(&mut self)
Halt the interpreter with an out-of-gas error.
pub fn halt_overflow(&mut self)
pub fn halt_overflow(&mut self)
Halt the interpreter with and overflow error.
pub fn halt_underflow(&mut self)
pub fn halt_underflow(&mut self)
Halt the interpreter with and underflow error.
pub fn halt_not_activated(&mut self)
pub fn halt_not_activated(&mut self)
Halt the interpreter with and not activated error.
pub fn return_with_output(&mut self, output: Bytes)
pub fn return_with_output(&mut self, output: Bytes)
Return with the given output.
This will set the action to InterpreterAction::Return
and set the gas to the current gas.
pub fn step<H>(
&mut self,
instruction_table: &[Instruction<IW, H>; 256],
host: &mut H,
)
pub fn step<H>( &mut self, instruction_table: &[Instruction<IW, H>; 256], host: &mut H, )
Executes the instruction at the current instruction pointer.
Internally it will increment instruction pointer by one.
pub fn step_dummy(
&mut self,
instruction_table: &[Instruction<IW, DummyHost>; 256],
)
pub fn step_dummy( &mut self, instruction_table: &[Instruction<IW, DummyHost>; 256], )
Executes the instruction at the current instruction pointer.
Internally it will increment instruction pointer by one.
This uses dummy Host.
pub fn run_plain<H>(
&mut self,
instruction_table: &[Instruction<IW, H>; 256],
host: &mut H,
) -> InterpreterAction
pub fn run_plain<H>( &mut self, instruction_table: &[Instruction<IW, H>; 256], host: &mut H, ) -> InterpreterAction
Executes the interpreter until it returns or stops.
§impl<IW> Interpreter<IW>
impl<IW> Interpreter<IW>
pub fn take_next_action_as_output(&mut self) -> <IW as InterpreterTypes>::Output
pub fn take_next_action_as_output(&mut self) -> <IW as InterpreterTypes>::Output
Takes the next action from the control and returns it as the specific Output type.
pub fn run_plain_as_output<H>(
&mut self,
instruction_table: &[Instruction<IW, H>; 256],
host: &mut H,
) -> <IW as InterpreterTypes>::Output
pub fn run_plain_as_output<H>( &mut self, instruction_table: &[Instruction<IW, H>; 256], host: &mut H, ) -> <IW as InterpreterTypes>::Output
Executes the interpreter until it returns or stops, returning the specific Output type.
Trait Implementations§
§impl<WIRE> Clone for Interpreter<WIRE>where
WIRE: Clone + InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Clone,
<WIRE as InterpreterTypes>::Stack: Clone,
<WIRE as InterpreterTypes>::ReturnData: Clone,
<WIRE as InterpreterTypes>::Memory: Clone,
<WIRE as InterpreterTypes>::Input: Clone,
<WIRE as InterpreterTypes>::RuntimeFlag: Clone,
<WIRE as InterpreterTypes>::Extend: Clone,
impl<WIRE> Clone for Interpreter<WIRE>where
WIRE: Clone + InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Clone,
<WIRE as InterpreterTypes>::Stack: Clone,
<WIRE as InterpreterTypes>::ReturnData: Clone,
<WIRE as InterpreterTypes>::Memory: Clone,
<WIRE as InterpreterTypes>::Input: Clone,
<WIRE as InterpreterTypes>::RuntimeFlag: Clone,
<WIRE as InterpreterTypes>::Extend: Clone,
§fn clone(&self) -> Interpreter<WIRE>
fn clone(&self) -> Interpreter<WIRE>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<WIRE> Debug for Interpreter<WIRE>where
WIRE: Debug + InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Debug,
<WIRE as InterpreterTypes>::Stack: Debug,
<WIRE as InterpreterTypes>::ReturnData: Debug,
<WIRE as InterpreterTypes>::Memory: Debug,
<WIRE as InterpreterTypes>::Input: Debug,
<WIRE as InterpreterTypes>::RuntimeFlag: Debug,
<WIRE as InterpreterTypes>::Extend: Debug,
impl<WIRE> Debug for Interpreter<WIRE>where
WIRE: Debug + InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Debug,
<WIRE as InterpreterTypes>::Stack: Debug,
<WIRE as InterpreterTypes>::ReturnData: Debug,
<WIRE as InterpreterTypes>::Memory: Debug,
<WIRE as InterpreterTypes>::Input: Debug,
<WIRE as InterpreterTypes>::RuntimeFlag: Debug,
<WIRE as InterpreterTypes>::Extend: Debug,
§impl Default for Interpreter
impl Default for Interpreter
§fn default() -> Interpreter
fn default() -> Interpreter
§impl<'de, WIRE> Deserialize<'de> for Interpreter<WIRE>where
WIRE: InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Deserialize<'de>,
<WIRE as InterpreterTypes>::Stack: Deserialize<'de>,
<WIRE as InterpreterTypes>::ReturnData: Deserialize<'de>,
<WIRE as InterpreterTypes>::Memory: Deserialize<'de>,
<WIRE as InterpreterTypes>::Input: Deserialize<'de>,
<WIRE as InterpreterTypes>::RuntimeFlag: Deserialize<'de>,
<WIRE as InterpreterTypes>::Extend: Deserialize<'de>,
impl<'de, WIRE> Deserialize<'de> for Interpreter<WIRE>where
WIRE: InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Deserialize<'de>,
<WIRE as InterpreterTypes>::Stack: Deserialize<'de>,
<WIRE as InterpreterTypes>::ReturnData: Deserialize<'de>,
<WIRE as InterpreterTypes>::Memory: Deserialize<'de>,
<WIRE as InterpreterTypes>::Input: Deserialize<'de>,
<WIRE as InterpreterTypes>::RuntimeFlag: Deserialize<'de>,
<WIRE as InterpreterTypes>::Extend: Deserialize<'de>,
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<Interpreter<WIRE>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<Interpreter<WIRE>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl<WIRE> Serialize for Interpreter<WIRE>where
WIRE: InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Serialize,
<WIRE as InterpreterTypes>::Stack: Serialize,
<WIRE as InterpreterTypes>::ReturnData: Serialize,
<WIRE as InterpreterTypes>::Memory: Serialize,
<WIRE as InterpreterTypes>::Input: Serialize,
<WIRE as InterpreterTypes>::RuntimeFlag: Serialize,
<WIRE as InterpreterTypes>::Extend: Serialize,
impl<WIRE> Serialize for Interpreter<WIRE>where
WIRE: InterpreterTypes,
<WIRE as InterpreterTypes>::Bytecode: Serialize,
<WIRE as InterpreterTypes>::Stack: Serialize,
<WIRE as InterpreterTypes>::ReturnData: Serialize,
<WIRE as InterpreterTypes>::Memory: Serialize,
<WIRE as InterpreterTypes>::Input: Serialize,
<WIRE as InterpreterTypes>::RuntimeFlag: Serialize,
<WIRE as InterpreterTypes>::Extend: Serialize,
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Auto Trait Implementations§
impl<WIRE> Freeze for Interpreter<WIRE>where
<WIRE as InterpreterTypes>::Bytecode: Freeze,
<WIRE as InterpreterTypes>::Stack: Freeze,
<WIRE as InterpreterTypes>::ReturnData: Freeze,
<WIRE as InterpreterTypes>::Memory: Freeze,
<WIRE as InterpreterTypes>::Input: Freeze,
<WIRE as InterpreterTypes>::RuntimeFlag: Freeze,
<WIRE as InterpreterTypes>::Extend: Freeze,
impl<WIRE> RefUnwindSafe for Interpreter<WIRE>where
<WIRE as InterpreterTypes>::Bytecode: RefUnwindSafe,
<WIRE as InterpreterTypes>::Stack: RefUnwindSafe,
<WIRE as InterpreterTypes>::ReturnData: RefUnwindSafe,
<WIRE as InterpreterTypes>::Memory: RefUnwindSafe,
<WIRE as InterpreterTypes>::Input: RefUnwindSafe,
<WIRE as InterpreterTypes>::RuntimeFlag: RefUnwindSafe,
<WIRE as InterpreterTypes>::Extend: RefUnwindSafe,
impl<WIRE> Send for Interpreter<WIRE>where
<WIRE as InterpreterTypes>::Bytecode: Send,
<WIRE as InterpreterTypes>::Stack: Send,
<WIRE as InterpreterTypes>::ReturnData: Send,
<WIRE as InterpreterTypes>::Memory: Send,
<WIRE as InterpreterTypes>::Input: Send,
<WIRE as InterpreterTypes>::RuntimeFlag: Send,
<WIRE as InterpreterTypes>::Extend: Send,
impl<WIRE> Sync for Interpreter<WIRE>where
<WIRE as InterpreterTypes>::Bytecode: Sync,
<WIRE as InterpreterTypes>::Stack: Sync,
<WIRE as InterpreterTypes>::ReturnData: Sync,
<WIRE as InterpreterTypes>::Memory: Sync,
<WIRE as InterpreterTypes>::Input: Sync,
<WIRE as InterpreterTypes>::RuntimeFlag: Sync,
<WIRE as InterpreterTypes>::Extend: Sync,
impl<WIRE> Unpin for Interpreter<WIRE>where
<WIRE as InterpreterTypes>::Bytecode: Unpin,
<WIRE as InterpreterTypes>::Stack: Unpin,
<WIRE as InterpreterTypes>::ReturnData: Unpin,
<WIRE as InterpreterTypes>::Memory: Unpin,
<WIRE as InterpreterTypes>::Input: Unpin,
<WIRE as InterpreterTypes>::RuntimeFlag: Unpin,
<WIRE as InterpreterTypes>::Extend: Unpin,
impl<WIRE> UnwindSafe for Interpreter<WIRE>where
<WIRE as InterpreterTypes>::Bytecode: UnwindSafe,
<WIRE as InterpreterTypes>::Stack: UnwindSafe,
<WIRE as InterpreterTypes>::ReturnData: UnwindSafe,
<WIRE as InterpreterTypes>::Memory: UnwindSafe,
<WIRE as InterpreterTypes>::Input: UnwindSafe,
<WIRE as InterpreterTypes>::RuntimeFlag: UnwindSafe,
<WIRE as InterpreterTypes>::Extend: UnwindSafe,
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> 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>,
§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> 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,
§impl<T> ServiceExt for T
impl<T> ServiceExt for T
§fn propagate_header(self, header: HeaderName) -> PropagateHeader<Self>where
Self: Sized,
fn propagate_header(self, header: HeaderName) -> PropagateHeader<Self>where
Self: Sized,
§fn add_extension<T>(self, value: T) -> AddExtension<Self, T>where
Self: Sized,
fn add_extension<T>(self, value: T) -> AddExtension<Self, T>where
Self: Sized,
§fn map_request_body<F>(self, f: F) -> MapRequestBody<Self, F>where
Self: Sized,
fn map_request_body<F>(self, f: F) -> MapRequestBody<Self, F>where
Self: Sized,
§fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
§fn compression(self) -> Compression<Self>where
Self: Sized,
fn compression(self) -> Compression<Self>where
Self: Sized,
§fn decompression(self) -> Decompression<Self>where
Self: Sized,
fn decompression(self) -> Decompression<Self>where
Self: Sized,
§fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
§fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
§fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
§fn sensitive_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<SetSensitiveResponseHeaders<Self>>where
Self: Sized,
fn sensitive_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<SetSensitiveResponseHeaders<Self>>where
Self: Sized,
§fn sensitive_request_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<Self>where
Self: Sized,
fn sensitive_request_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<Self>where
Self: Sized,
§fn sensitive_response_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveResponseHeaders<Self>where
Self: Sized,
fn sensitive_response_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveResponseHeaders<Self>where
Self: Sized,
§fn override_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
fn override_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
§fn append_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
fn append_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
§fn insert_request_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
fn insert_request_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
§fn override_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
fn override_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
§fn append_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
fn append_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
§fn insert_response_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
fn insert_response_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
§fn set_request_id<M>(
self,
header_name: HeaderName,
make_request_id: M,
) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
fn set_request_id<M>(
self,
header_name: HeaderName,
make_request_id: M,
) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
§fn set_x_request_id<M>(self, make_request_id: M) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
fn set_x_request_id<M>(self, make_request_id: M) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
x-request-id
as the header name. Read more§fn propagate_request_id(
self,
header_name: HeaderName,
) -> PropagateRequestId<Self>where
Self: Sized,
fn propagate_request_id(
self,
header_name: HeaderName,
) -> PropagateRequestId<Self>where
Self: Sized,
§fn propagate_x_request_id(self) -> PropagateRequestId<Self>where
Self: Sized,
fn propagate_x_request_id(self) -> PropagateRequestId<Self>where
Self: Sized,
x-request-id
as the header name. Read more§fn catch_panic(self) -> CatchPanic<Self, DefaultResponseForPanic>where
Self: Sized,
fn catch_panic(self) -> CatchPanic<Self, DefaultResponseForPanic>where
Self: Sized,
500 Internal Server
responses. Read more§fn request_body_limit(self, limit: usize) -> RequestBodyLimit<Self>where
Self: Sized,
fn request_body_limit(self, limit: usize) -> RequestBodyLimit<Self>where
Self: Sized,
413 Payload Too Large
responses. Read more§fn trim_trailing_slash(self) -> NormalizePath<Self>where
Self: Sized,
fn trim_trailing_slash(self) -> NormalizePath<Self>where
Self: Sized,
§fn append_trailing_slash(self) -> NormalizePath<Self>where
Self: Sized,
fn append_trailing_slash(self) -> NormalizePath<Self>where
Self: 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> 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> ⓘ
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<'de, T> BorrowedRpcObject<'de> for Twhere
T: RpcBorrow<'de> + RpcSend,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
impl<T> MaybeSerde for Twhere
T: Serialize + for<'de> Deserialize<'de>,
impl<T> NippyJarHeader for T
impl<'de, T> RpcBorrow<'de> for T
impl<T> RpcObject for Twhere
T: RpcSend + RpcRecv,
impl<T> RpcRecv for T
impl<T> RpcSend for T
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.