Enum Transaction
pub enum Transaction {
Legacy(TxLegacy),
Eip2930(TxEip2930),
Eip1559(TxEip1559),
Eip4844(TxEip4844),
Eip7702(TxEip7702),
Deposit(TxDeposit),
}
Expand description
A raw transaction.
Transaction types were introduced in EIP-2718.
Variants§
Legacy(TxLegacy)
Legacy transaction (type 0x0
).
Traditional Ethereum transactions, containing parameters nonce
, gasPrice
, gasLimit
,
to
, value
, data
, v
, r
, and s
.
These transactions do not utilize access lists nor do they incorporate EIP-1559 fee market changes.
Eip2930(TxEip2930)
Transaction with an AccessList
(EIP-2930), type 0x1
.
The accessList
specifies an array of addresses and storage keys that the transaction
plans to access, enabling gas savings on cross-contract calls by pre-declaring the accessed
contract and storage slots.
Eip1559(TxEip1559)
A transaction with a priority fee (EIP-1559), type 0x2
.
Unlike traditional transactions, EIP-1559 transactions use an in-protocol, dynamically changing base fee per gas, adjusted at each block to manage network congestion.
maxPriorityFeePerGas
, specifying the maximum fee above the base fee the sender is willing to paymaxFeePerGas
, setting the maximum total fee the sender is willing to pay.
The base fee is burned, while the priority fee is paid to the miner who includes the transaction, incentivizing miners to include transactions with higher priority fees per gas.
Eip4844(TxEip4844)
Shard Blob Transactions (EIP-4844), type 0x3
.
Shard Blob Transactions introduce a new transaction type called a blob-carrying transaction to reduce gas costs. These transactions are similar to regular Ethereum transactions but include additional data called a blob.
Blobs are larger (~125 kB) and cheaper than the current calldata, providing an immutable and read-only memory for storing transaction data.
EIP-4844, also known as proto-danksharding, implements the framework and logic of danksharding, introducing new transaction formats and verification rules.
Eip7702(TxEip7702)
EOA Set Code Transactions (EIP-7702), type 0x4
.
EOA Set Code Transactions give the ability to temporarily set contract code for an EOA for a single transaction. This allows for temporarily adding smart contract functionality to the EOA.
Deposit(TxDeposit)
optimism
only.Optimism deposit transaction.
Implementations§
§impl Transaction
impl Transaction
pub fn signature_hash(&self) -> FixedBytes<32>
pub fn signature_hash(&self) -> FixedBytes<32>
Heavy operation that return signature hash over rlp encoded transaction. It is only for signature signing or signer recovery.
pub fn set_chain_id(&mut self, chain_id: u64)
pub fn set_chain_id(&mut self, chain_id: u64)
Sets the transaction’s chain id to the provided value.
pub const fn kind(&self) -> TxKind
pub const fn kind(&self) -> TxKind
Gets the transaction’s TxKind
, which is the address of the recipient or
TxKind::Create
if the transaction is a contract creation.
pub fn to(&self) -> Option<Address>
pub fn to(&self) -> Option<Address>
Get the transaction’s address of the contract that will be called, or the address that will receive the transfer.
Returns None
if this is a CREATE
transaction.
pub const fn access_list(&self) -> Option<&AccessList>
pub const fn access_list(&self) -> Option<&AccessList>
Returns the AccessList
of the transaction.
Returns None
for legacy transactions.
Returns the SignedAuthorization
list of the transaction.
Returns None
if this transaction is not EIP-7702.
pub const fn is_dynamic_fee(&self) -> bool
pub const fn is_dynamic_fee(&self) -> bool
Returns true if the tx supports dynamic fees
pub fn blob_versioned_hashes(&self) -> Option<Vec<FixedBytes<32>>>
pub fn blob_versioned_hashes(&self) -> Option<Vec<FixedBytes<32>>>
Blob versioned hashes for eip4844 transaction, for legacy, eip1559, eip2930 and eip7702
transactions this is None
This is also commonly referred to as the “blob versioned hashes” (BlobVersionedHashes
).
pub fn blob_gas_used(&self) -> Option<u64>
pub fn blob_gas_used(&self) -> Option<u64>
Returns the blob gas used for all blobs of the EIP-4844 transaction if it is an EIP-4844 transaction.
This is the number of blobs times the
DATA_GAS_PER_BLOB
a single blob consumes.
pub fn effective_tip_per_gas(&self, base_fee: Option<u64>) -> Option<u128>
pub fn effective_tip_per_gas(&self, base_fee: Option<u64>) -> Option<u128>
Returns the effective miner gas tip cap (gasTipCap
) for the given base fee:
min(maxFeePerGas - baseFee, maxPriorityFeePerGas)
If the base fee is None
, the max_priority_fee_per_gas
, or gas price for non-EIP1559
transactions is returned.
Returns None
if the basefee is higher than the Transaction::max_fee_per_gas
.
pub fn encode_for_signing(&self, out: &mut dyn BufMut)
pub fn encode_for_signing(&self, out: &mut dyn BufMut)
This encodes the transaction without the signature, and is only suitable for creating a hash intended for signing.
pub fn eip2718_encode(
&self,
signature: &PrimitiveSignature,
out: &mut dyn BufMut,
)
pub fn eip2718_encode( &self, signature: &PrimitiveSignature, out: &mut dyn BufMut, )
Produces EIP-2718 encoding of the transaction
pub fn set_gas_limit(&mut self, gas_limit: u64)
pub fn set_gas_limit(&mut self, gas_limit: u64)
This sets the transaction’s gas limit.
pub const fn is_eip2930(&self) -> bool
pub const fn is_eip2930(&self) -> bool
Returns true if the transaction is an EIP-2930 transaction.
pub const fn is_eip1559(&self) -> bool
pub const fn is_eip1559(&self) -> bool
Returns true if the transaction is an EIP-1559 transaction.
pub const fn is_eip4844(&self) -> bool
pub const fn is_eip4844(&self) -> bool
Returns true if the transaction is an EIP-4844 transaction.
pub const fn is_eip7702(&self) -> bool
pub const fn is_eip7702(&self) -> bool
Returns true if the transaction is an EIP-7702 transaction.
pub const fn as_legacy(&self) -> Option<&TxLegacy>
pub const fn as_legacy(&self) -> Option<&TxLegacy>
Returns the [TxLegacy
] variant if the transaction is a legacy transaction.
pub const fn as_eip2930(&self) -> Option<&TxEip2930>
pub const fn as_eip2930(&self) -> Option<&TxEip2930>
Returns the [TxEip2930
] variant if the transaction is an EIP-2930 transaction.
pub const fn as_eip1559(&self) -> Option<&TxEip1559>
pub const fn as_eip1559(&self) -> Option<&TxEip1559>
Returns the [TxEip1559
] variant if the transaction is an EIP-1559 transaction.
pub const fn as_eip4844(&self) -> Option<&TxEip4844>
pub const fn as_eip4844(&self) -> Option<&TxEip4844>
Returns the [TxEip4844
] variant if the transaction is an EIP-4844 transaction.
pub const fn as_eip7702(&self) -> Option<&TxEip7702>
pub const fn as_eip7702(&self) -> Option<&TxEip7702>
Returns the [TxEip7702
] variant if the transaction is an EIP-7702 transaction.
Trait Implementations§
§impl<'a> Arbitrary<'a> for Transaction
Available on crate feature arbitrary
only.
impl<'a> Arbitrary<'a> for Transaction
arbitrary
only.§fn arbitrary(u: &mut Unstructured<'a>) -> Result<Transaction, Error>
fn arbitrary(u: &mut Unstructured<'a>) -> Result<Transaction, Error>
Self
from the given unstructured data. Read more§fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
Self
from the entirety of the given
unstructured data. Read more§fn size_hint(depth: usize) -> (usize, Option<usize>)
fn size_hint(depth: usize) -> (usize, Option<usize>)
Unstructured
this type
needs to construct itself. Read more§fn try_size_hint(
depth: usize,
) -> Result<(usize, Option<usize>), MaxRecursionReached>
fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>
Unstructured
this type
needs to construct itself. Read more§impl AsRef<Transaction> for TransactionSigned
impl AsRef<Transaction> for TransactionSigned
§fn as_ref(&self) -> &Transaction
fn as_ref(&self) -> &Transaction
§impl AsRef<Transaction> for TransactionSignedNoHash
impl AsRef<Transaction> for TransactionSignedNoHash
§fn as_ref(&self) -> &Transaction
fn as_ref(&self) -> &Transaction
§impl AsRef<Transaction> for TransactionSignedVariant
impl AsRef<Transaction> for TransactionSignedVariant
§fn as_ref(&self) -> &Transaction
fn as_ref(&self) -> &Transaction
§impl Clone for Transaction
impl Clone for Transaction
§fn clone(&self) -> Transaction
fn clone(&self) -> Transaction
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Compact for Transaction
Available on crate feature reth-codec
only.
impl Compact for Transaction
reth-codec
only.§fn to_compact<B>(&self, buf: &mut B) -> usize
fn to_compact<B>(&self, buf: &mut B) -> usize
§fn from_compact(buf: &[u8], identifier: usize) -> (Transaction, &[u8])
fn from_compact(buf: &[u8], identifier: usize) -> (Transaction, &[u8])
buf
with its internal cursor
advanced (eg..advance(len)
). Read more§fn specialized_to_compact<B>(&self, buf: &mut B) -> usize
fn specialized_to_compact<B>(&self, buf: &mut B) -> usize
§fn specialized_from_compact(buf: &[u8], len: usize) -> (Self, &[u8])
fn specialized_from_compact(buf: &[u8], len: usize) -> (Self, &[u8])
§impl Debug for Transaction
impl Debug for Transaction
§impl Default for Transaction
impl Default for Transaction
§fn default() -> Transaction
fn default() -> Transaction
§impl DepositTransaction for Transaction
Available on crate feature optimism
only.
impl DepositTransaction for Transaction
optimism
only.§fn source_hash(&self) -> Option<FixedBytes<32>>
fn source_hash(&self) -> Option<FixedBytes<32>>
§fn mint(&self) -> Option<u128>
fn mint(&self) -> Option<u128>
§fn is_system_transaction(&self) -> bool
fn is_system_transaction(&self) -> bool
§fn is_deposit(&self) -> bool
fn is_deposit(&self) -> bool
§impl<'de> Deserialize<'de> for Transaction
impl<'de> Deserialize<'de> for Transaction
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<Transaction, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<Transaction, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl<'de> DeserializeAs<'de, Transaction> for Transaction<'de>
impl<'de> DeserializeAs<'de, Transaction> for Transaction<'de>
§fn deserialize_as<D>(
deserializer: D,
) -> Result<Transaction, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize_as<D>(
deserializer: D,
) -> Result<Transaction, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
§impl<'a> From<&'a Transaction> for Transaction<'a>
impl<'a> From<&'a Transaction> for Transaction<'a>
§fn from(value: &'a Transaction) -> Transaction<'a>
fn from(value: &'a Transaction) -> Transaction<'a>
§impl From<MockTransaction> for Transaction
impl From<MockTransaction> for Transaction
§fn from(mock: MockTransaction) -> Transaction
fn from(mock: MockTransaction) -> Transaction
§impl<'a> From<Transaction<'a>> for Transaction
impl<'a> From<Transaction<'a>> for Transaction
§fn from(value: Transaction<'a>) -> Transaction
fn from(value: Transaction<'a>) -> Transaction
§impl From<TxDeposit> for Transaction
impl From<TxDeposit> for Transaction
§fn from(value: TxDeposit) -> Transaction
fn from(value: TxDeposit) -> Transaction
§impl From<TxEip1559> for Transaction
impl From<TxEip1559> for Transaction
§fn from(value: TxEip1559) -> Transaction
fn from(value: TxEip1559) -> Transaction
§impl From<TxEip2930> for Transaction
impl From<TxEip2930> for Transaction
§fn from(value: TxEip2930) -> Transaction
fn from(value: TxEip2930) -> Transaction
§impl From<TxEip4844> for Transaction
impl From<TxEip4844> for Transaction
§fn from(value: TxEip4844) -> Transaction
fn from(value: TxEip4844) -> Transaction
§impl From<TxEip7702> for Transaction
impl From<TxEip7702> for Transaction
§fn from(value: TxEip7702) -> Transaction
fn from(value: TxEip7702) -> Transaction
§impl From<TxLegacy> for Transaction
impl From<TxLegacy> for Transaction
§fn from(value: TxLegacy) -> Transaction
fn from(value: TxLegacy) -> Transaction
§impl Hash for Transaction
impl Hash for Transaction
§impl InMemorySize for Transaction
impl InMemorySize for Transaction
§fn size(&self) -> usize
fn size(&self) -> usize
Calculates a heuristic for the in-memory size of the Transaction.
§impl PartialEq for Transaction
impl PartialEq for Transaction
§impl Serialize for Transaction
impl Serialize for Transaction
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
§impl SerializeAs<Transaction> for Transaction<'_>
impl SerializeAs<Transaction> for Transaction<'_>
§fn serialize_as<S>(
source: &Transaction,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize_as<S>(
source: &Transaction,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
§impl Transaction for Transaction
impl Transaction for Transaction
§fn max_fee_per_gas(&self) -> u128
fn max_fee_per_gas(&self) -> u128
§fn max_priority_fee_per_gas(&self) -> Option<u128>
fn max_priority_fee_per_gas(&self) -> Option<u128>
§fn max_fee_per_blob_gas(&self) -> Option<u128>
fn max_fee_per_blob_gas(&self) -> Option<u128>
§fn priority_fee_or_price(&self) -> u128
fn priority_fee_or_price(&self) -> u128
§fn effective_gas_price(&self, base_fee: Option<u64>) -> u128
fn effective_gas_price(&self, base_fee: Option<u64>) -> u128
§fn is_dynamic_fee(&self) -> bool
fn is_dynamic_fee(&self) -> bool
true
if the transaction supports dynamic fees.§fn access_list(&self) -> Option<&AccessList>
fn access_list(&self) -> Option<&AccessList>
access_list
for the particular transaction type. Returns None
for
older transaction types.§fn blob_versioned_hashes(&self) -> Option<&[FixedBytes<32>]>
fn blob_versioned_hashes(&self) -> Option<&[FixedBytes<32>]>
None
.SignedAuthorization
list of the transaction. Read more§impl TransactionExt for Transaction
impl TransactionExt for Transaction
§fn signature_hash(&self) -> FixedBytes<32>
fn signature_hash(&self) -> FixedBytes<32>
impl Eq for Transaction
impl StructuralPartialEq for Transaction
Auto Trait Implementations§
impl !Freeze for Transaction
impl RefUnwindSafe for Transaction
impl Send for Transaction
impl Sync for Transaction
impl Unpin for Transaction
impl UnwindSafe for Transaction
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
Source§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
impl<A> ArbInterop for A
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> FullTransaction for Twhere
T: Transaction + Compact,
impl<T> MaybeArbitrary for Twhere
T: for<'a> Arbitrary<'a>,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
impl<T> NippyJarHeader for T
impl<T> RpcObject for Twhere
T: RpcParam + RpcReturn,
impl<T> RpcParam for T
impl<T> RpcReturn for T
impl<T> Transaction 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: 224 bytes
Size for each variant:
Legacy
: 144 bytesEip2930
: 160 bytesEip1559
: 176 bytesEip4844
: 208 bytesEip7702
: 192 bytesDeposit
: 192 bytes