reth_op::provider

Struct ExecutionOutcome

Help

pub struct ExecutionOutcome<T = Receipt> {
    pub bundle: BundleState,
    pub receipts: Vec<Vec<T>>,
    pub first_block: u64,
    pub requests: Vec<Requests>,
}

Available on crate feature provider only.

Expand description

Represents the outcome of block execution, including post-execution changes and reverts.

The ExecutionOutcome structure aggregates the state changes over an arbitrary number of blocks, capturing the resulting state, receipts, and requests following the execution.

Fields§

§bundle: BundleState

Bundle state with reverts.

§receipts: Vec<Vec<T>>

The collection of receipts. Outer vector stores receipts for each block sequentially. The inner vector stores receipts ordered by transaction number.

§first_block: u64

First block of bundle state.

§requests: Vec<Requests>

The collection of EIP-7685 requests. Outer vector stores requests for each block sequentially. The inner vector stores requests ordered by transaction number.

A transaction may have zero or more requests, so the length of the inner vector is not guaranteed to be the same as the number of transactions.

Implementations§

impl<T> ExecutionOutcome<T>

pub const fn new( bundle: BundleState, receipts: Vec<Vec<T>>, first_block: u64, requests: Vec<Requests>, ) -> ExecutionOutcome<T>

Available on crate feature evm only.

Creates a new ExecutionOutcome.

This constructor initializes a new ExecutionOutcome instance with the provided bundle state, receipts, first block number, and EIP-7685 requests.

pub fn new_init( state_init: HashMap<Address, (Option<Account>, Option<Account>, HashMap<FixedBytes<32>, (Uint<256, 4>, Uint<256, 4>), RandomState>), RandomState>, revert_init: HashMap<u64, HashMap<Address, (Option<Option<Account>>, Vec<StorageEntry>), RandomState>, RandomState>, contracts_init: impl IntoIterator<Item = (FixedBytes<32>, Bytecode)>, receipts: Vec<Vec<T>>, first_block: u64, requests: Vec<Requests>, ) -> ExecutionOutcome<T>

Available on crate feature evm only.

Creates a new ExecutionOutcome from initialization parameters.

This constructor initializes a new ExecutionOutcome instance using detailed initialization parameters.

pub fn single( block_number: u64, output: BlockExecutionOutput<T>, ) -> ExecutionOutcome<T>

Available on crate feature evm only.

Creates a new ExecutionOutcome from a single block execution result.

pub fn from_blocks( first_block: u64, bundle: BundleState, results: Vec<BlockExecutionResult<T>>, ) -> ExecutionOutcome<T>

Available on crate feature evm only.

Creates a new ExecutionOutcome from multiple BlockExecutionResults.

pub const fn state(&self) -> &BundleState

Available on crate feature evm only.

Return revm bundle state.

pub fn state_mut(&mut self) -> &mut BundleState

Available on crate feature evm only.

Returns mutable revm bundle state.

pub fn set_first_block(&mut self, first_block: u64)

Available on crate feature evm only.

Set first block.

pub fn accounts_iter( &self, ) -> impl Iterator<Item = (Address, Option<&AccountInfo>)>

Available on crate feature evm only.

Return iterator over all accounts

pub fn bundle_accounts_iter( &self, ) -> impl Iterator<Item = (Address, &BundleAccount)>

Available on crate feature evm only.

Return iterator over all [BundleAccount]s in the bundle

pub fn account(&self, address: &Address) -> Option<Option<Account>>

Available on crate feature evm only.

Get account if account is known.

pub fn storage( &self, address: &Address, storage_key: Uint<256, 4>, ) -> Option<Uint<256, 4>>

Available on crate feature evm only.

Get storage if value is known.

This means that depending on status we can potentially return U256::ZERO.

pub fn bytecode(&self, code_hash: &FixedBytes<32>) -> Option<Bytecode>

Available on crate feature evm only.

Return bytecode if known.

pub fn hash_state_slow<KH>(&self) -> HashedPostState
where KH: KeyHasher,

Available on crate feature evm only.

Returns HashedPostState for this execution outcome. See HashedPostState::from_bundle_state for more info.

pub fn block_number_to_index(&self, block_number: u64) -> Option<usize>

Available on crate feature evm only.

Transform block number to the index of block.

pub fn generic_receipts_root_slow( &self, block_number: u64, f: impl FnOnce(&[T]) -> FixedBytes<32>, ) -> Option<FixedBytes<32>>

Available on crate feature evm only.

Returns the receipt root for all recorded receipts. Note: this function calculated Bloom filters for every receipt and created merkle trees of receipt. This is a expensive operation.

pub const fn receipts(&self) -> &Vec<Vec<T>>

Available on crate feature evm only.

Returns reference to receipts.

pub fn receipts_mut(&mut self) -> &mut Vec<Vec<T>>

Available on crate feature evm only.

Returns mutable reference to receipts.

pub fn receipts_by_block(&self, block_number: u64) -> &[T]

Available on crate feature evm only.

Return all block receipts

pub fn is_empty(&self) -> bool

Available on crate feature evm only.

Is execution outcome empty.

pub fn len(&self) -> usize

Available on crate feature evm only.

Number of blocks in the execution outcome.

pub const fn first_block(&self) -> u64

Available on crate feature evm only.

Return first block of the execution outcome

pub fn last_block(&self) -> u64

Available on crate feature evm only.

Return last block of the execution outcome

pub fn revert_to(&mut self, block_number: u64) -> bool

Available on crate feature evm only.

Revert the state to the given block number.

Returns false if the block number is not in the bundle state.

§Note

The provided block number will stay inside the bundle state.

pub fn split_at( self, at: u64, ) -> (Option<ExecutionOutcome<T>>, ExecutionOutcome<T>)
where T: Clone,

Available on crate feature evm only.

Splits the block range state at a given block number. Returns two split states ([..at], [at..]). The plain state of the 2nd bundle state will contain extra changes that were made in state transitions belonging to the lower state.

§Panics

If the target block number is not included in the state block range.

pub fn extend(&mut self, other: ExecutionOutcome<T>)

Available on crate feature evm only.

Extend one state from another

For state this is very sensitive operation and should be used only when we know that other state was build on top of this one. In most cases this would be true.

pub fn prepend_state(&mut self, other: BundleState)

Available on crate feature evm only.

Prepends present the state with the given BundleState. It adds changes from the given state but does not override any existing changes.

Reverts and receipts are not updated.

pub fn with_receipts(self, receipts: Vec<Vec<T>>) -> ExecutionOutcome<T>

Available on crate feature evm only.

Create a new instance with updated receipts.

pub fn with_requests(self, requests: Vec<Requests>) -> ExecutionOutcome<T>

Available on crate feature evm only.

Create a new instance with updated requests.

pub fn changed_accounts(&self) -> impl Iterator<Item = ChangedAccount>

Available on crate feature evm only.

Returns an iterator over all changed accounts from the ExecutionOutcome.

This method filters the accounts to return only those that have undergone changes and maps them into ChangedAccount instances, which include the address, nonce, and balance.

impl<T> ExecutionOutcome<T>
where T: Receipt<Log = Log>,

pub fn logs(&self, block_number: u64) -> Option<impl Iterator<Item = &Log>>

Available on crate feature evm only.

Returns an iterator over all block logs.

pub fn block_logs_bloom(&self, block_number: u64) -> Option<Bloom>

Available on crate feature evm only.

Return blocks logs bloom

impl ExecutionOutcome

pub fn ethereum_receipts_root( &self, block_number: u64, ) -> Option<FixedBytes<32>>

Available on crate feature evm only.

Returns the ethereum receipt root for all recorded receipts.

Note: this function calculated Bloom filters for every receipt and created merkle trees of receipt. This is a expensive operation.

Trait Implementations§

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

fn clone(&self) -> ExecutionOutcome<T>

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for ExecutionOutcome<T>
where T: Debug,

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

Formats the value using the given formatter. Read more

impl<T> Default for ExecutionOutcome<T>

fn default() -> ExecutionOutcome<T>

Returns the “default value” for a type. Read more

impl<'de, T> Deserialize<'de> for ExecutionOutcome<T>
where T: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<ExecutionOutcome<T>, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<'de, T> DeserializeAs<'de, ExecutionOutcome<T>> for ExecutionOutcome<'de, T>
where T: SerdeBincodeCompat + Debug,

fn deserialize_as<D>( deserializer: D, ) -> Result<ExecutionOutcome<T>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExecutionDataProvider for ExecutionOutcome

fn block_hash(&self, _block_number: u64) -> Option<FixedBytes<32>>

Always returns None because we don’t have any information about the block header.

fn execution_outcome(&self) -> &ExecutionOutcome

Return the execution outcome.

impl<'a, T> From<&'a ExecutionOutcome<T>> for ExecutionOutcome<'a, T>
where T: SerdeBincodeCompat + Debug,

fn from(value: &'a ExecutionOutcome<T>) -> ExecutionOutcome<'a, T>

Converts to this type from the input type.

impl<T> From<(BlockExecutionOutput<T>, u64)> for ExecutionOutcome<T>

fn from(_: (BlockExecutionOutput<T>, u64)) -> ExecutionOutcome<T>

Converts to this type from the input type.

impl<'a, T> From<ExecutionOutcome<'a, T>> for ExecutionOutcome<T>
where T: SerdeBincodeCompat + Debug,

fn from(value: ExecutionOutcome<'a, T>) -> ExecutionOutcome<T>

Converts to this type from the input type.

impl<T> PartialEq for ExecutionOutcome<T>
where T: PartialEq,

fn eq(&self, other: &ExecutionOutcome<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> SerdeBincodeCompat for ExecutionOutcome<T>
where T: SerdeBincodeCompat + Debug,

type BincodeRepr<'a> = ExecutionOutcome<'a, T>

Serde representation of the type for bincode serialization. Read more

fn as_repr( &self, ) -> <ExecutionOutcome<T> as SerdeBincodeCompat>::BincodeRepr<'_>

Convert this type into its bincode representation

fn from_repr( repr: <ExecutionOutcome<T> as SerdeBincodeCompat>::BincodeRepr<'_>, ) -> ExecutionOutcome<T>

Convert from the bincode representation

impl<T> Serialize for ExecutionOutcome<T>
where T: Serialize,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<T> SerializeAs<ExecutionOutcome<T>> for ExecutionOutcome<'_, T>
where T: SerdeBincodeCompat + Debug,

fn serialize_as<S>( source: &ExecutionOutcome<T>, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for ExecutionOutcome<T>
where T: Eq,

impl<T> StructuralPartialEq for ExecutionOutcome<T>

Auto Trait Implementations§

impl<T> Freeze for ExecutionOutcome<T>

impl<T> RefUnwindSafe for ExecutionOutcome<T>
where T: RefUnwindSafe,

impl<T> Send for ExecutionOutcome<T>
where T: Send,

impl<T> Sync for ExecutionOutcome<T>
where T: Sync,

impl<T> Unpin for ExecutionOutcome<T>
where T: Unpin,

impl<T> UnwindSafe for ExecutionOutcome<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

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

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

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

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

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

impl<T> From<T> for T

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

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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> 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());

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

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

§Example

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

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

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: 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: 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> Same for T

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> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

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

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

impl<T> MaybeDebug for T
where T: Debug,

impl<T> MaybeSend for T
where T: Send,

impl<T> MaybeSendSync for T

impl<T> MaybeSerde for T
where T: Serialize + for<'de> Deserialize<'de>,

impl<T> MaybeSerdeBincodeCompat for T
where T: SerdeBincodeCompat,

impl<T> NippyJarHeader for T
where T: Send + Sync + Serialize + for<'b> Deserialize<'b> + Debug + 'static,

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 176 bytes