Skip to main content

Executor

Struct Executor 

Source
pub struct Executor<FEN>
where FEN: FoundryEvmNetwork,
{ backend: Arc<Backend<FEN>>, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, tx: <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest, inspector: InspectorStack<FEN>, gas_limit: u64, legacy_assertions: bool, collect_setup_storage: bool, }
Expand description

EVM executor.

The executor can be configured with various evm2 inspectors, like Cheatcodes.

There are multiple ways of interacting the EVM:

  • call: executes a transaction, but does not persist any state changes; similar to eth_call, where the EVM state is unchanged after the call.
  • transact: executes a transaction and persists the state changes
  • deploy: a special case of transact, specialized for persisting the state of a contract deployment
  • setup: a special case of transact, used to set up the environment for a test

Every execution builds an EVM from the backend, installs the inspector stack, which holds the backend for the run, and then parks the EVM into the backend to commit or drops it to discard.

Fields§

§backend: Arc<Backend<FEN>>§evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>§tx: <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest§inspector: InspectorStack<FEN>§gas_limit: u64§legacy_assertions: bool§collect_setup_storage: bool

Implementations§

Source§

impl<FEN> Executor<FEN>
where FEN: FoundryEvmNetwork,

Source

pub fn new( backend: Backend<FEN>, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, tx: <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest, inspector: InspectorStack<FEN>, networks: NetworkConfigs, gas_limit: u64, legacy_assertions: bool, ) -> Executor<FEN>

Creates a new Executor with the given arguments.

Source

pub fn backend(&self) -> &Backend<FEN>

Returns a reference to the EVM backend.

Source

pub fn backend_mut(&mut self) -> &mut Backend<FEN>

Returns a mutable reference to the EVM backend.

Uses copy-on-write semantics: if other clones of this executor share the backend, this will clone the backend first.

Source

pub const fn evm_env( &self, ) -> &EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>

Returns a reference to the EVM environment.

Source

pub const fn evm_env_mut( &mut self, ) -> &mut EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>

Returns a mutable reference to the EVM environment.

Source

pub const fn tx( &self, ) -> &<<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest

Returns the transaction defaults of the executor’s calls.

Source

pub const fn tx_mut( &mut self, ) -> &mut <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest

Returns the transaction defaults of the executor’s calls mutably.

Source

pub const fn inspector(&self) -> &InspectorStack<FEN>

Returns a reference to the EVM inspector.

Source

pub const fn inspector_mut(&mut self) -> &mut InspectorStack<FEN>

Returns a mutable reference to the EVM inspector.

Source

pub const fn spec_id( &self, ) -> <<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId

Returns the EVM spec.

Source

pub fn set_spec_id( &mut self, spec_id: <<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::SpecId, )

Sets the EVM spec and updates spec-dependent gas parameters.

Source

pub const fn gas_limit(&self) -> u64

Returns the gas limit for calls and deployments.

This is different from the gas limit imposed by the passed in environment, as those limits are used by the EVM for certain opcodes like gaslimit.

Source

pub const fn set_gas_limit(&mut self, gas_limit: u64)

Sets the gas limit for calls and deployments.

Source

pub const fn legacy_assertions(&self) -> bool

Returns whether failed() should be called on the test contract to determine if the test failed.

Source

pub const fn set_legacy_assertions(&mut self, legacy_assertions: bool)

Sets whether failed() should be called on the test contract to determine if the test failed.

Source

pub fn deploy_create2_deployer(&mut self) -> Result<(), Report>

Creates the default CREATE2 Contract Deployer for local tests and scripts.

Source

pub fn set_balance( &mut self, address: Address, amount: Uint<256, 4>, ) -> Result<(), BackendError>

Set the balance of an account.

Source

pub fn get_balance( &self, address: Address, ) -> Result<Uint<256, 4>, BackendError>

Gets the balance of an account

Source

pub fn set_account_nonce( &mut self, address: Address, nonce: u64, ) -> Result<(), BackendError>

Sets the nonce of an account without modifying the transaction defaults.

Source

pub fn set_nonce( &mut self, address: Address, nonce: u64, ) -> Result<(), BackendError>

Sets the nonce of an account and the transaction defaults.

Source

pub fn get_nonce(&self, address: Address) -> Result<u64, BackendError>

Returns the nonce of an account.

Source

pub fn set_code( &mut self, address: Address, code: Bytecode, ) -> Result<(), BackendError>

Set the code of an account.

Source

pub fn set_storage( &mut self, address: Address, storage: HashMap<Uint<256, 4>, Uint<256, 4>, DefaultHashBuilder>, ) -> Result<(), BackendError>

Set the storage of an account.

Source

pub fn set_storage_slot( &mut self, address: Address, slot: Uint<256, 4>, value: Uint<256, 4>, ) -> Result<(), BackendError>

Set a storage slot of an account.

Source

pub fn apply_prestate_trace( &mut self, prestate: BTreeMap<Address, AccountState>, ) -> Result<(), Report>

Apply prestate trace data to the executor’s backend.

This is used to set up the EVM state based on the prestate trace from debug_traceTransaction, which provides all accounts and storage slots that will be accessed during transaction execution.

Source

pub fn is_empty_code(&self, address: Address) -> Result<bool, BackendError>

Returns true if the account has no code.

Source

pub fn set_trace_requirements( &mut self, requirements: TraceRequirements, ) -> &mut Executor<FEN>

Source

pub fn set_script_execution(&mut self, script_address: Address)

Source

pub fn set_trace_printer(&mut self, trace_printer: bool) -> &mut Executor<FEN>

Source

pub fn create2_deployer(&self) -> Address

Source

pub fn deploy( &mut self, from: Address, code: Bytes, value: Uint<256, 4>, rd: Option<&RevertDecoder>, ) -> Result<DeployResult<FEN>, EvmError<FEN>>

Deploys a contract and commits the new state to the underlying database.

Executes a CREATE transaction with the contract code and persistent database state modifications.

Source

pub fn deploy_with_env( &mut self, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, tx: <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest, rd: Option<&RevertDecoder>, ) -> Result<DeployResult<FEN>, EvmError<FEN>>

Deploys a contract using the given environment and transaction and commits the new state to the underlying database.

§Panics

Panics if tx is not a create transaction.

Source

pub fn persist_deployment( &mut self, result: RawCallResult<FEN>, rd: Option<&RevertDecoder>, ) -> Result<DeployResult<FEN>, EvmError<FEN>>

Turns the committed result of a creation into a deployment, marking the created contract persistent so that its state survives fork switches.

§Panics

Panics if a successful creation returned no address.

Source

pub fn setup( &mut self, from: Option<Address>, to: Address, rd: Option<&RevertDecoder>, ) -> Result<RawCallResult<FEN>, EvmError<FEN>>

Calls the setUp() function on a contract.

This will commit any state changes to the underlying database.

Ayn changes made during the setup call to env’s block environment are persistent, for example vm.chainId() will change the block.chainId for all subsequent test calls.

Source

pub fn call( &self, from: Address, to: Address, func: &Function, args: &[DynSolValue], value: Uint<256, 4>, rd: Option<&RevertDecoder>, ) -> Result<CallResult<DynSolValue, FEN>, EvmError<FEN>>

Performs a call to an account on the current state of the VM.

Source

pub fn call_sol<C>( &self, from: Address, to: Address, args: &C, value: Uint<256, 4>, rd: Option<&RevertDecoder>, ) -> Result<CallResult<<C as SolCall>::Return, FEN>, EvmError<FEN>>
where C: SolCall,

Performs a call to an account on the current state of the VM.

Source

pub fn transact( &mut self, from: Address, to: Address, func: &Function, args: &[DynSolValue], value: Uint<256, 4>, rd: Option<&RevertDecoder>, ) -> Result<CallResult<DynSolValue, FEN>, EvmError<FEN>>

Performs a call to an account on the current state of the VM.

Source

pub fn call_raw( &self, from: Address, to: Address, calldata: Bytes, value: Uint<256, 4>, ) -> Result<RawCallResult<FEN>, Report>

Performs a raw call to an account on the current state of the VM.

Source

pub fn call_raw_with_authorization( &mut self, from: Address, to: Address, calldata: Bytes, value: Uint<256, 4>, authorization_list: Vec<SignedAuthorization>, ) -> Result<RawCallResult<FEN>, Report>

Performs a raw call to an account on the current state of the VM with an EIP-7702 authorization list.

Source

pub fn transact_raw( &mut self, from: Address, to: Address, calldata: Bytes, value: Uint<256, 4>, ) -> Result<RawCallResult<FEN>, Report>

Performs a raw call to an account on the current state of the VM.

Source

pub fn transact_raw_with_authorization( &mut self, from: Address, to: Address, calldata: Bytes, value: Uint<256, 4>, authorization_list: Vec<SignedAuthorization>, ) -> Result<RawCallResult<FEN>, Report>

Performs a raw call to an account on the current state of the VM with an EIP-7702 authorization last.

Source

pub fn apply_beacon_root( &mut self, parent_beacon_block_root: FixedBytes<32>, ) -> Result<(), Report>

Applies the EIP-4788 beacon roots system call (Cancun+). https://eips.ethereum.org/EIPS/eip-4788

Source

pub fn call_with_env( &self, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, tx: <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest, ) -> Result<RawCallResult<FEN>, Report>

Executes the transaction tx with evm_env.

The state after the call is not persisted.

Source

pub fn call_tx( &self, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, tx: &Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>, ext: Option<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::EvmExt>, ) -> Result<RawCallResult<FEN>, Report>

Executes the converted transaction tx with evm_env, and ext or extension state prepared for tx, without persisting its state.

The result’s stipend is zero, since tx is opaque; see calculate_stipend.

Source

pub fn call_raw_without_fuzz_instrumentation( &self, from: Address, to: Address, calldata: Bytes, value: Uint<256, 4>, ) -> Result<RawCallResult<FEN>, Report>

Performs a raw call like Self::call_raw, but without the fuzz guidance inspectors.

The call collects no edge coverage, comparison operands, or dictionary values, so use it for calls whose instrumentation output is discarded, such as invariant predicate checks.

Source

pub fn transact_with_env( &mut self, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, tx: <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest, ) -> Result<RawCallResult<FEN>, Report>

Executes the transaction tx with evm_env and persists its state.

Source

pub fn transact_tx( &mut self, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, tx: &Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>, ext: Option<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::EvmExt>, ) -> Result<RawCallResult<FEN>, Report>

Executes the converted transaction tx with evm_env, and ext or extension state prepared for tx, and persists its state.

Source

pub fn transact_with_block_replay( &mut self, evm_env: EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, target: &Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>, target_kind: TxKind, replay: &[(FixedBytes<32>, Recovered<<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>)], ) -> Result<RawCallResult<FEN>, Report>

Replays the transactions preceding target in its block, then executes target with the inspectors and persists the state of all of them.

The caller selects which prefix transactions replay. target_kind is the target’s kind, which decides the test contract.

Source

pub fn is_raw_call_mut_success( &self, address: Address, call_result: &mut RawCallResult<FEN>, ) -> bool

Returns true if a test can be considered successful.

This is the same as Self::is_success, but will consume the state_changeset map to use internally when calling failed().

Source

pub fn is_raw_call_success( &self, address: Address, state_changeset: Cow<'_, PendingState>, call_result: &RawCallResult<FEN>, ) -> bool

Returns true if a test can be considered successful.

This is the same as Self::is_success, but intended for outcomes of Self::call_raw.

Source

pub fn is_raw_call_mut_success_handler_gate( &self, address: Address, call_result: &mut RawCallResult<FEN>, ) -> bool

Like Self::is_raw_call_mut_success but uses Self::is_success_handler_gate under the hood. Intended for invariant view-call success checks during a campaign where the committed GLOBAL_FAIL_SLOT may be stale poison from a previously-recorded handler bug.

Source

pub fn is_success( &self, address: Address, reverted: bool, state_changeset: Cow<'_, PendingState>, ) -> bool

Returns true if a test can be considered successful.

If the call succeeded, we also have to check the global and local failure flags.

These are set by the test contract itself when an assertion fails, using the internal fail function. The global flag is located in CHEATCODE_ADDRESS at slot GLOBAL_FAIL_SLOT, and the local flag is located in the test contract at an unspecified slot.

This behavior is inherited from Dapptools, where initially only a public failed variable was used to track test failures, and later, a global failure flag was introduced to track failures across multiple contracts in ds-test#30.

The assumption is that the test runner calls failed on the test contract to determine if it failed. However, we want to avoid this as much as possible, as it is relatively expensive to set up an EVM call just for checking a single boolean flag.

See:

Source

pub fn is_success_handler_gate( &self, address: Address, reverted: bool, state_changeset: Cow<'_, PendingState>, ) -> bool

Like Self::is_success but ignores the committed GLOBAL_FAIL_SLOT and only treats the slot as failed when this call’s in-flight changeset writes it. Used by the invariant runner’s per-call handler-success gate, where a 1 already in committed storage is just stale poison from a previously-recorded handler bug (separately tracked) and must not suppress later assert_invariants / afterInvariant evaluations.

Source

pub fn has_pending_global_failure(state_changeset: &PendingState) -> bool

Returns whether the in-flight state changeset for the current call sets the global assertion failure flag.

Source

pub fn has_global_failure(&self, state_changeset: &PendingState) -> bool

Returns whether the global assertion failure flag is set either in the in-flight state changeset or in the committed backend state.

Source

pub fn prepare_call_env( &self, caller: Address, kind: TxKind, data: Bytes, value: Uint<256, 4>, ) -> (EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest)

Creates the environment and transaction to use when executing a call in a test context.

The transaction executes with no fees and the executor’s gas limit, from caller’s current nonce. If using a backend with cheatcodes, the gas price and block are overwritten by the cheatcode state in between calls.

Source

pub fn call_sol_default<C>( &self, to: Address, args: &C, ) -> <C as SolCall>::Return
where C: SolCall, <C as SolCall>::Return: Default,

Source

pub const fn set_collect_setup_storage(&mut self, enabled: bool)

Enables returning retained storage observations from committing setup calls. Disable this before running tests so campaigns do not copy setup-only metadata.

Source§

impl Executor<MonadEvmNetwork>

Source

pub fn transact_with_monad_block_replay( &mut self, env: EvmEnv<<<MonadEvmNetwork as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>, target: &Recovered<<<<MonadEvmNetwork as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>, target_kind: TxKind, replay: &[(FixedBytes<32>, Recovered<<<<MonadEvmNetwork as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types as EvmTypesHost>::Tx>)], context: BlockContext<MonadEvmNetwork>, ) -> Result<RawCallResult<MonadEvmNetwork>, Report>

Available on crate feature monad only.

Like Executor::transact_with_block_replay, positioning the prefix and target in the Monad block context. The block is trusted history: its canonical protocol transactions replay as protocol system calls, and a non-canonical envelope from the protocol sender is rejected.

Trait Implementations§

Source§

impl<FEN> Clone for Executor<FEN>
where FEN: Clone + FoundryEvmNetwork,

Source§

fn clone(&self) -> Executor<FEN>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<FEN> Debug for Executor<FEN>
where FEN: Debug + FoundryEvmNetwork,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<FEN> !Freeze for Executor<FEN>

§

impl<FEN> !RefUnwindSafe for Executor<FEN>

§

impl<FEN> !UnwindSafe for Executor<FEN>

§

impl<FEN> Send for Executor<FEN>
where Arc<Backend<FEN>>: Send, EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>: Send, <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest: Send, InspectorStack<FEN>: Send,

§

impl<FEN> Sync for Executor<FEN>
where Arc<Backend<FEN>>: Sync, EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>: Sync, <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest: Sync, InspectorStack<FEN>: Sync,

§

impl<FEN> Unpin for Executor<FEN>
where Arc<Backend<FEN>>: Unpin, EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>: Unpin, <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest: Unpin, InspectorStack<FEN>: Unpin,

§

impl<FEN> UnsafeUnpin for Executor<FEN>
where Arc<Backend<FEN>>: UnsafeUnpin, EvmEnv<<<FEN as FoundryEvmNetwork>::EvmFactory as FoundryEvmFactory>::Types>: UnsafeUnpin, <<FEN as FoundryEvmNetwork>::Network as Network>::TransactionRequest: UnsafeUnpin, InspectorStack<FEN>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, R> CollectAndApply<T, R> for T

§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<TxEnv, T> FromRecoveredTx<&T> for TxEnv
where TxEnv: FromRecoveredTx<T>,

§

fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv

Builds a [TxEnv] from a transaction and a sender address.
§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnv
where TxEnv: FromTxWithEncoded<T>,

§

fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv

Builds a [TxEnv] from a transaction, its sender, and encoded transaction bytes.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> MaybeCompact for T

§

impl<T> NonStaticAny for T
where T: ?Sized,

§

fn type_id(&self) -> TypeId

Returns the lifetime-erased type ID of self.
§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [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,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [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>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
§

impl<T> Paint for T
where T: ?Sized,

§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling [Attribute] value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi [Quirk] value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1:

renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the [Condition] value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more
§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> Threaded<T> for T

§

type Rest = ()

The outputs beyond the threaded value.
§

fn split(self) -> (T, ())

Splits into the threaded value and the extra outputs.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryClone for T
where T: Clone,

§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.