reth::transaction_pool::test_utils

Enum MockTransaction

pub enum MockTransaction {
    Legacy {
        chain_id: Option<u64>,
        hash: FixedBytes<32>,
        sender: Address,
        nonce: u64,
        gas_price: u128,
        gas_limit: u64,
        to: TxKind,
        value: Uint<256, 4>,
        input: Bytes,
        size: usize,
        cost: Uint<256, 4>,
    },
    Eip2930 {
        chain_id: u64,
        hash: FixedBytes<32>,
        sender: Address,
        nonce: u64,
        to: TxKind,
        gas_limit: u64,
        input: Bytes,
        value: Uint<256, 4>,
        gas_price: u128,
        access_list: AccessList,
        size: usize,
        cost: Uint<256, 4>,
    },
    Eip1559 {
Show 13 fields
        chain_id: u64,
        hash: FixedBytes<32>,
        sender: Address,
        nonce: u64,
        max_fee_per_gas: u128,
        max_priority_fee_per_gas: u128,
        gas_limit: u64,
        to: TxKind,
        value: Uint<256, 4>,
        access_list: AccessList,
        input: Bytes,
        size: usize,
        cost: Uint<256, 4>,
    
},
    Eip4844 {
Show 15 fields
        chain_id: u64,
        hash: FixedBytes<32>,
        sender: Address,
        nonce: u64,
        max_fee_per_gas: u128,
        max_priority_fee_per_gas: u128,
        max_fee_per_blob_gas: u128,
        gas_limit: u64,
        to: Address,
        value: Uint<256, 4>,
        access_list: AccessList,
        input: Bytes,
        sidecar: BlobTransactionSidecar,
        size: usize,
        cost: Uint<256, 4>,
    
},
}
Available on crate feature test-utils only.
Expand description

A Bare transaction type used for testing.

Variants§

§

Legacy

Legacy transaction type.

Fields

§chain_id: Option<u64>

The chain id of the transaction.

§hash: FixedBytes<32>

The hash of the transaction.

§sender: Address

The sender’s address.

§nonce: u64

The transaction nonce.

§gas_price: u128

The gas price for the transaction.

§gas_limit: u64

The gas limit for the transaction.

§to: TxKind

The transaction’s destination.

§value: Uint<256, 4>

The value of the transaction.

§input: Bytes

The transaction input data.

§size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

§cost: Uint<256, 4>

The cost of the transaction, returned in the implementation of PoolTransaction.

§

Eip2930

EIP-2930 transaction type.

Fields

§chain_id: u64

The chain id of the transaction.

§hash: FixedBytes<32>

The hash of the transaction.

§sender: Address

The sender’s address.

§nonce: u64

The transaction nonce.

§to: TxKind

The transaction’s destination.

§gas_limit: u64

The gas limit for the transaction.

§input: Bytes

The transaction input data.

§value: Uint<256, 4>

The value of the transaction.

§gas_price: u128

The gas price for the transaction.

§access_list: AccessList

The access list associated with the transaction.

§size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

§cost: Uint<256, 4>

The cost of the transaction, returned in the implementation of PoolTransaction.

§

Eip1559

EIP-1559 transaction type.

Fields

§chain_id: u64

The chain id of the transaction.

§hash: FixedBytes<32>

The hash of the transaction.

§sender: Address

The sender’s address.

§nonce: u64

The transaction nonce.

§max_fee_per_gas: u128

The maximum fee per gas for the transaction.

§max_priority_fee_per_gas: u128

The maximum priority fee per gas for the transaction.

§gas_limit: u64

The gas limit for the transaction.

§to: TxKind

The transaction’s destination.

§value: Uint<256, 4>

The value of the transaction.

§access_list: AccessList

The access list associated with the transaction.

§input: Bytes

The transaction input data.

§size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

§cost: Uint<256, 4>

The cost of the transaction, returned in the implementation of PoolTransaction.

§

Eip4844

EIP-4844 transaction type.

Fields

§chain_id: u64

The chain id of the transaction.

§hash: FixedBytes<32>

The hash of the transaction.

§sender: Address

The sender’s address.

§nonce: u64

The transaction nonce.

§max_fee_per_gas: u128

The maximum fee per gas for the transaction.

§max_priority_fee_per_gas: u128

The maximum priority fee per gas for the transaction.

§max_fee_per_blob_gas: u128

The maximum fee per blob gas for the transaction.

§gas_limit: u64

The gas limit for the transaction.

§to: Address

The transaction’s destination.

§value: Uint<256, 4>

The value of the transaction.

§access_list: AccessList

The access list associated with the transaction.

§input: Bytes

The transaction input data.

§sidecar: BlobTransactionSidecar

The sidecar information for the transaction.

§size: usize

The size of the transaction, returned in the implementation of PoolTransaction.

§cost: Uint<256, 4>

The cost of the transaction, returned in the implementation of PoolTransaction.

Implementations§

§

impl MockTransaction

pub fn set_nonce(&mut self, nonce: u64) -> &mut MockTransaction

Sets the value of the specified field.

pub fn with_nonce(self, nonce: u64) -> MockTransaction

Sets the value of the specified field using a fluent interface.

pub const fn get_nonce(&self) -> &u64

Gets the value of the specified field.

pub fn set_hash(&mut self, hash: FixedBytes<32>) -> &mut MockTransaction

Sets the value of the specified field.

pub fn with_hash(self, hash: FixedBytes<32>) -> MockTransaction

Sets the value of the specified field using a fluent interface.

pub const fn get_hash(&self) -> &FixedBytes<32>

Gets the value of the specified field.

pub fn set_sender(&mut self, sender: Address) -> &mut MockTransaction

Sets the value of the specified field.

pub fn with_sender(self, sender: Address) -> MockTransaction

Sets the value of the specified field using a fluent interface.

pub const fn get_sender(&self) -> &Address

Gets the value of the specified field.

pub fn set_gas_limit(&mut self, gas_limit: u64) -> &mut MockTransaction

Sets the value of the specified field.

pub fn with_gas_limit(self, gas_limit: u64) -> MockTransaction

Sets the value of the specified field using a fluent interface.

pub const fn get_gas_limit(&self) -> &u64

Gets the value of the specified field.

pub fn set_value(&mut self, value: Uint<256, 4>) -> &mut MockTransaction

Sets the value of the specified field.

pub fn with_value(self, value: Uint<256, 4>) -> MockTransaction

Sets the value of the specified field using a fluent interface.

pub const fn get_value(&self) -> &Uint<256, 4>

Gets the value of the specified field.

pub fn set_input(&mut self, input: Bytes) -> &mut MockTransaction

Sets the value of the specified field.

pub fn with_input(self, input: Bytes) -> MockTransaction

Sets the value of the specified field using a fluent interface.

pub const fn get_input(&self) -> &Bytes

Gets the value of the specified field.

pub fn set_size(&mut self, size: usize) -> &mut MockTransaction

Sets the value of the specified field.

pub fn with_size(self, size: usize) -> MockTransaction

Sets the value of the specified field using a fluent interface.

pub const fn get_size(&self) -> &usize

Gets the value of the specified field.

pub fn legacy() -> MockTransaction

Returns a new legacy transaction with random address and hash and empty values

pub fn eip2930() -> MockTransaction

Returns a new EIP2930 transaction with random address and hash and empty values

pub fn eip1559() -> MockTransaction

Returns a new EIP1559 transaction with random address and hash and empty values

pub fn eip4844() -> MockTransaction

Returns a new EIP4844 transaction with random address and hash and empty values

pub fn eip4844_with_sidecar(sidecar: BlobTransactionSidecar) -> MockTransaction

Returns a new EIP4844 transaction with a provided sidecar

pub fn new_from_type(tx_type: TxType) -> MockTransaction

Creates a new transaction with the given TxType.

See the default constructors for each of the transaction types:

pub fn with_blob_fee(self, val: u128) -> MockTransaction

Sets the max fee per blob gas for EIP-4844 transactions,

pub fn set_blob_fee(&mut self, val: u128) -> &mut MockTransaction

Sets the max fee per blob gas for EIP-4844 transactions,

pub fn set_priority_fee(&mut self, val: u128) -> &mut MockTransaction

Sets the priority fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn with_priority_fee(self, val: u128) -> MockTransaction

Sets the priority fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub const fn get_priority_fee(&self) -> Option<u128>

Gets the priority fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn set_max_fee(&mut self, val: u128) -> &mut MockTransaction

Sets the max fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn with_max_fee(self, val: u128) -> MockTransaction

Sets the max fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub const fn get_max_fee(&self) -> Option<u128>

Gets the max fee for dynamic fee transactions (EIP-1559 and EIP-4844)

pub fn set_accesslist(&mut self, list: AccessList) -> &mut MockTransaction

Sets the access list for transactions supporting EIP-1559, EIP-4844, and EIP-2930.

pub fn set_gas_price(&mut self, val: u128) -> &mut MockTransaction

Sets the gas price for the transaction.

pub fn with_gas_price(self, val: u128) -> MockTransaction

Sets the gas price for the transaction.

pub const fn get_gas_price(&self) -> u128

Gets the gas price for the transaction.

pub fn prev(&self) -> MockTransaction

Returns a clone with a decreased nonce

pub fn next(&self) -> MockTransaction

Returns a clone with an increased nonce

pub fn skip(&self, skip: u64) -> MockTransaction

Returns a clone with an increased nonce

pub fn inc_nonce(self) -> MockTransaction

Returns a clone with incremented nonce

pub fn rng_hash(self) -> MockTransaction

Sets a new random hash

pub fn inc_price(&self) -> MockTransaction

Returns a new transaction with a higher gas price +1

pub fn inc_price_by(&self, value: u128) -> MockTransaction

Returns a new transaction with a higher gas price

pub fn decr_price(&self) -> MockTransaction

Returns a new transaction with a lower gas price -1

pub fn decr_price_by(&self, value: u128) -> MockTransaction

Returns a new transaction with a lower gas price

pub fn inc_value(&self) -> MockTransaction

Returns a new transaction with a higher value

pub fn inc_limit(&self) -> MockTransaction

Returns a new transaction with a higher gas limit

pub fn inc_blob_fee(&self) -> MockTransaction

Returns a new transaction with a higher blob fee +1

If it’s an EIP-4844 transaction.

pub fn inc_blob_fee_by(&self, value: u128) -> MockTransaction

Returns a new transaction with a higher blob fee

If it’s an EIP-4844 transaction.

pub fn decr_blob_fee(&self) -> MockTransaction

Returns a new transaction with a lower blob fee -1

If it’s an EIP-4844 transaction.

pub fn decr_blob_fee_by(&self, value: u128) -> MockTransaction

Returns a new transaction with a lower blob fee

If it’s an EIP-4844 transaction.

pub const fn tx_type(&self) -> u8

Returns the transaction type identifier associated with the current MockTransaction.

pub const fn is_legacy(&self) -> bool

Checks if the transaction is of the legacy type.

pub const fn is_eip1559(&self) -> bool

Checks if the transaction is of the EIP-1559 type.

pub const fn is_eip4844(&self) -> bool

Checks if the transaction is of the EIP-4844 type.

pub const fn is_eip2930(&self) -> bool

Checks if the transaction is of the EIP-2930 type.

Trait Implementations§

§

impl Arbitrary for MockTransaction

Available on crate feature arbitrary only.
§

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.
§

type Strategy = BoxedStrategy<MockTransaction>

The type of Strategy used to generate values of type Self.
§

fn arbitrary_with( _: <MockTransaction as Arbitrary>::Parameters, ) -> <MockTransaction as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more
§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
§

impl Clone for MockTransaction

§

fn clone(&self) -> MockTransaction

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 Debug for MockTransaction

§

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

Formats the value using the given formatter. Read more
§

impl EthPoolTransaction for MockTransaction

§

fn take_blob(&mut self) -> EthBlobTransactionSidecar

Extracts the blob sidecar from the transaction.
§

fn blob_count(&self) -> usize

Returns the number of blobs this transaction has.
§

fn try_into_pooled_eip4844( self, sidecar: Arc<BlobTransactionSidecar>, ) -> Option<<MockTransaction as PoolTransaction>::Pooled>

A specialization for the EIP-4844 transaction type. Tries to reattach the blob sidecar to the transaction. Read more
§

fn validate_blob( &self, _blob: &BlobTransactionSidecar, _settings: &KZGSettings, ) -> Result<(), BlobTransactionValidationError>

Validates the blob sidecar of the transaction with the given settings.
§

fn authorization_count(&self) -> usize

Returns the number of authorizations this transaction has.
§

impl From<MockTransaction> for Transaction

§

fn from(mock: MockTransaction) -> Transaction

Converts to this type from the input type.
§

impl From<MockTransaction> for TransactionSignedEcRecovered

§

fn from(tx: MockTransaction) -> TransactionSignedEcRecovered

Converts to this type from the input type.
§

impl From<PooledTransactionsElementEcRecovered> for MockTransaction

§

fn from(tx: PooledTransactionsElementEcRecovered) -> MockTransaction

Converts to this type from the input type.
§

impl PartialEq for MockTransaction

§

fn eq(&self, other: &MockTransaction) -> 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 PoolTransaction for MockTransaction

§

fn effective_tip_per_gas(&self, base_fee: u64) -> Option<u128>

Calculates the effective tip per gas given a base fee.

§

fn priority_fee_or_price(&self) -> u128

Returns the priority fee or gas price based on the transaction type.

§

fn kind(&self) -> TxKind

Returns the transaction kind associated with the transaction.

§

fn input(&self) -> &[u8] ⓘ

Returns the input data associated with the transaction.

§

fn size(&self) -> usize

Returns the size of the transaction.

§

fn tx_type(&self) -> u8

Returns the transaction type as a byte identifier.

§

fn encoded_length(&self) -> usize

Returns the encoded length of the transaction.

§

fn chain_id(&self) -> Option<u64>

Returns the chain ID associated with the transaction.

§

type TryFromConsensusError = TryFromRecoveredTransactionError

Associated error type for the try_from_consensus method.
§

type Consensus = TransactionSignedEcRecovered

Associated type representing the raw consensus variant of the transaction.
§

type Pooled = PooledTransactionsElementEcRecovered

Associated type representing the recovered pooled variant of the transaction.
§

fn try_from_consensus( tx: <MockTransaction as PoolTransaction>::Consensus, ) -> Result<MockTransaction, <MockTransaction as PoolTransaction>::TryFromConsensusError>

Define a method to convert from the Consensus type to Self
§

fn into_consensus(self) -> <MockTransaction as PoolTransaction>::Consensus

Define a method to convert from the Self type to Consensus
§

fn from_pooled( pooled: <MockTransaction as PoolTransaction>::Pooled, ) -> MockTransaction

Define a method to convert from the Pooled type to Self
§

fn try_consensus_into_pooled( tx: <MockTransaction as PoolTransaction>::Consensus, ) -> Result<<MockTransaction as PoolTransaction>::Pooled, <MockTransaction as PoolTransaction>::TryFromConsensusError>

Tries to convert the Consensus type into the Pooled type.
§

fn hash(&self) -> &FixedBytes<32>

Hash of the transaction.
§

fn sender(&self) -> Address

The Sender of the transaction.
§

fn nonce(&self) -> u64

Returns the nonce for this transaction.
§

fn cost(&self) -> &Uint<256, 4>

Returns the cost that this transaction is allowed to consume: Read more
§

fn gas_limit(&self) -> u64

Amount of gas that should be used in executing this transaction. This is paid up-front.
§

fn max_fee_per_gas(&self) -> u128

Returns the EIP-1559 the maximum fee per gas the caller is willing to pay. Read more
§

fn access_list(&self) -> Option<&AccessList>

Returns the access_list for the particular transaction type. For Legacy transactions, returns default.
§

fn max_priority_fee_per_gas(&self) -> Option<u128>

Returns the EIP-1559 Priority fee the caller is paying to the block author. Read more
§

fn max_fee_per_blob_gas(&self) -> Option<u128>

Returns the EIP-4844 max fee per data gas Read more
§

fn try_into_pooled(self) -> Result<Self::Pooled, Self::TryFromConsensusError>

Tries to convert the Consensus type into the Pooled type.
§

fn to(&self) -> Option<Address>

Returns the recipient of the transaction if it is not a TxKind::Create transaction.
§

fn is_eip1559(&self) -> bool

Returns true if the transaction is an EIP-1559 transaction.
§

fn is_eip4844(&self) -> bool

Returns true if the transaction is an EIP-4844 transaction.
§

fn is_eip7702(&self) -> bool

Returns true if the transaction is an EIP-7702 transaction.
§

fn ensure_max_init_code_size( &self, max_init_code_size: usize, ) -> Result<(), InvalidPoolTransactionError>

Ensures that the transaction’s code size does not exceed the provided max_init_code_size. Read more
§

impl TryFrom<TransactionSignedEcRecovered> for MockTransaction

§

type Error = TryFromRecoveredTransactionError

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

fn try_from( tx: TransactionSignedEcRecovered, ) -> Result<MockTransaction, <MockTransaction as TryFrom<TransactionSignedEcRecovered>>::Error>

Performs the conversion.
§

impl Eq for MockTransaction

§

impl StructuralPartialEq for MockTransaction

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

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

Source§

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

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

Source§

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

Source§

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

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

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

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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

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

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

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

impl<T> WithSubscriber for T

Source§

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

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

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

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

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

Size for each variant:

  • Legacy: 240 bytes
  • Eip2930: 256 bytes
  • Eip1559: 272 bytes
  • Eip4844: 352 bytes