reth::primitives

Struct TransactionSigned

pub struct TransactionSigned {
    pub hash: FixedBytes<32>,
    pub signature: PrimitiveSignature,
    pub transaction: Transaction,
}
Expand description

Signed transaction.

Fields§

§hash: FixedBytes<32>

Transaction hash

§signature: PrimitiveSignature

The transaction signature values

§transaction: Transaction

Raw transaction info

Implementations§

§

impl TransactionSigned

pub const fn signature(&self) -> &PrimitiveSignature

Transaction signature.

pub const fn transaction(&self) -> &Transaction

Transaction

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

Transaction hash. Used to identify transaction.

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

Reference to transaction hash. Used to identify transaction.

pub fn recover_signer(&self) -> Option<Address>

Recover signer from signature and hash.

Returns None if the transaction’s signature is invalid following EIP-2, see also recover_signer.

Note:

This can fail for some early ethereum mainnet transactions pre EIP-2, use Self::recover_signer_unchecked if you want to recover the signer without ensuring that the signature has a low s value.

pub fn recover_signer_unchecked(&self) -> Option<Address>

Recover signer from signature and hash without ensuring that the signature has a low s value.

Returns None if the transaction’s signature is invalid, see also recover_signer_unchecked.

pub fn recover_signers<'a, T>(txes: T, num_txes: usize) -> Option<Vec<Address>>
where T: IntoParallelIterator<Item = &'a TransactionSigned> + IntoIterator<Item = &'a TransactionSigned> + Send,

Recovers a list of signers from a transaction list iterator.

Returns None, if some transaction’s signature is invalid, see also Self::recover_signer.

pub fn recover_signers_unchecked<'a, T>( txes: T, num_txes: usize, ) -> Option<Vec<Address>>
where T: IntoParallelIterator<Item = &'a TransactionSigned> + IntoIterator<Item = &'a TransactionSigned>,

Recovers a list of signers from a transaction list iterator without ensuring that the signature has a low s value.

Returns None, if some transaction’s signature is invalid, see also Self::recover_signer_unchecked.

pub const fn with_signer(self, signer: Address) -> TransactionSignedEcRecovered

Returns the TransactionSignedEcRecovered transaction with the given sender.

pub fn into_ecrecovered(self) -> Option<TransactionSignedEcRecovered>

Consumes the type, recover signer and return TransactionSignedEcRecovered

Returns None if the transaction’s signature is invalid, see also Self::recover_signer.

pub fn into_ecrecovered_unchecked(self) -> Option<TransactionSignedEcRecovered>

Consumes the type, recover signer and return TransactionSignedEcRecovered without ensuring that the signature has a low s value (EIP-2).

Returns None if the transaction’s signature is invalid, see also Self::recover_signer_unchecked.

pub fn try_ecrecovered(&self) -> Option<TransactionSignedEcRecovered>

Tries to recover signer and return TransactionSignedEcRecovered by cloning the type.

pub fn try_into_ecrecovered( self, ) -> Result<TransactionSignedEcRecovered, TransactionSigned>

Tries to recover signer and return TransactionSignedEcRecovered.

Returns Err(Self) if the transaction’s signature is invalid, see also Self::recover_signer.

pub fn try_into_ecrecovered_unchecked( self, ) -> Result<TransactionSignedEcRecovered, TransactionSigned>

Tries to recover signer and return TransactionSignedEcRecovered. without ensuring that the signature has a low s value (EIP-2).

Returns Err(Self) if the transaction’s signature is invalid, see also Self::recover_signer_unchecked.

pub fn recalculate_hash(&self) -> FixedBytes<32>

Calculate transaction hash, eip2728 transaction does not contain rlp header and start with tx type.

pub fn from_transaction_and_signature( transaction: Transaction, signature: PrimitiveSignature, ) -> TransactionSigned

Create a new signed transaction from a transaction and its signature.

This will also calculate the transaction hash using its encoding.

pub fn decode_rlp_legacy_transaction( data: &mut &[u8], ) -> Result<TransactionSigned, Error>

Decodes legacy transaction from the data buffer.

This should be used only be used in general transaction decoding methods, which have already ensured that the input is a legacy transaction with the following format: rlp(legacy_tx)

Legacy transactions are encoded as lists, so the input should start with a RLP list header.

This expects rlp(legacy_tx)

Methods from Deref<Target = Transaction>§

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

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 fn tx_type(&self) -> TxType

Get the transaction’s type

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

Returns the AccessList of the transaction.

Returns None for legacy transactions.

pub fn authorization_list(&self) -> Option<&[SignedAuthorization]>

Returns the SignedAuthorization list of the transaction.

Returns None if this transaction is not EIP-7702.

pub fn is_dynamic_fee(&self) -> bool

Returns true if the tx supports dynamic fees

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>

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>

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 input(&self) -> &Bytes

Get the transaction’s input field.

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

Produces EIP-2718 encoding of the transaction

pub fn is_legacy(&self) -> bool

Returns true if the transaction is a legacy transaction.

pub fn is_eip2930(&self) -> bool

Returns true if the transaction is an EIP-2930 transaction.

pub fn is_eip1559(&self) -> bool

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

pub fn is_eip4844(&self) -> bool

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

pub fn is_eip7702(&self) -> bool

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

pub fn as_legacy(&self) -> Option<&TxLegacy>

Returns the [TxLegacy] variant if the transaction is a legacy transaction.

pub fn as_eip2930(&self) -> Option<&TxEip2930>

Returns the [TxEip2930] variant if the transaction is an EIP-2930 transaction.

pub fn as_eip1559(&self) -> Option<&TxEip1559>

Returns the [TxEip1559] variant if the transaction is an EIP-1559 transaction.

pub fn as_eip4844(&self) -> Option<&TxEip4844>

Returns the [TxEip4844] variant if the transaction is an EIP-4844 transaction.

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

Available on crate feature arbitrary only.
§

fn arbitrary(u: &mut Unstructured<'a>) -> Result<TransactionSigned, Error>

Generate an arbitrary value of Self from the given unstructured data. Read more
§

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more
§

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
§

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
§

impl AsRef<Transaction> for TransactionSigned

§

fn as_ref(&self) -> &Transaction

Converts this type into a shared reference of the (usually inferred) input type.
§

impl AsRef<TransactionSigned> for TransactionSigned

§

fn as_ref(&self) -> &TransactionSigned

Converts this type into a shared reference of the (usually inferred) input type.
§

impl AsRef<TransactionSigned> for TransactionSignedEcRecovered

§

fn as_ref(&self) -> &TransactionSigned

Converts this type into a shared reference of the (usually inferred) input type.
§

impl Clone for TransactionSigned

§

fn clone(&self) -> TransactionSigned

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 Compact for TransactionSigned

Available on crate feature reth-codec only.
§

fn to_compact<B>(&self, buf: &mut B) -> usize
where B: BufMut + AsMut<[u8]>,

Takes a buffer which can be written to. Ideally, it returns the length written to.
§

fn from_compact(buf: &[u8], len: usize) -> (TransactionSigned, &[u8])

Takes a buffer which can be read from. Returns the object and buf with its internal cursor advanced (eg..advance(len)). Read more
§

fn specialized_to_compact<B>(&self, buf: &mut B) -> usize
where B: BufMut + AsMut<[u8]>,

“Optional”: If there’s no good reason to use it, don’t.
§

fn specialized_from_compact(buf: &[u8], len: usize) -> (Self, &[u8])

“Optional”: If there’s no good reason to use it, don’t.
§

impl Compress for TransactionSigned

§

type Compressed = Vec<u8>

Compressed type.
§

fn compress_to_buf<B>(self, buf: &mut B)
where B: BufMut + AsMut<[u8]>,

Compresses data to a given buffer.
§

fn uncompressable_ref(&self) -> Option<&[u8]>

If the type cannot be compressed, return its inner reference as Some(self.as_ref())
§

fn compress(self) -> Self::Compressed

Compresses data going into the database.
§

impl Debug for TransactionSigned

§

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

Formats the value using the given formatter. Read more
§

impl Decodable for TransactionSigned

§

fn decode(buf: &mut &[u8]) -> Result<TransactionSigned, Error>

This Decodable implementation only supports decoding rlp encoded transactions as it’s used by p2p.

The p2p encoding format always includes an RLP header, although the type RLP header depends on whether or not the transaction is a legacy transaction.

If the transaction is a legacy transaction, it is just encoded as a RLP list: rlp(tx-data).

If the transaction is a typed transaction, it is encoded as a RLP string: rlp(tx-type || rlp(tx-data))

This can be used for decoding all signed transactions in p2p BlockBodies responses.

This cannot be used for decoding EIP-4844 transactions in p2p PooledTransactions, since the EIP-4844 variant of TransactionSigned does not include the blob sidecar.

For a method suitable for decoding pooled transactions, see PooledTransactionsElement.

CAUTION: Due to a quirk in [Header::decode], this method will succeed even if a typed transaction is encoded in this format, and does not start with a RLP header: tx-type || rlp(tx-data).

This is because [Header::decode] does not advance the buffer, and returns a length-1 string header if the first byte is less than 0xf7.

§

impl Decodable2718 for TransactionSigned

§

fn typed_decode( ty: u8, buf: &mut &[u8], ) -> Result<TransactionSigned, Eip2718Error>

Decode the appropriate variant, based on the type flag. Read more
§

fn fallback_decode(buf: &mut &[u8]) -> Result<TransactionSigned, Eip2718Error>

Decode the default variant. Read more
§

fn extract_type_byte(buf: &mut &[u8]) -> Option<u8>

Extract the type byte from the buffer, if any. The type byte is the first byte, provided that that first byte is 0x7f or lower.
§

fn decode_2718(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Encode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction. Read more
§

fn network_decode(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Decode an EIP-2718 transaction in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client. Read more
§

impl Decompress for TransactionSigned

§

fn decompress(value: &[u8]) -> Result<TransactionSigned, DatabaseError>

Decompresses data coming from the database.
§

fn decompress_owned(value: Vec<u8>) -> Result<Self, DatabaseError>

Decompresses owned data coming from the database.
§

impl Default for TransactionSigned

§

fn default() -> TransactionSigned

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

impl Deref for TransactionSigned

§

type Target = Transaction

The resulting type after dereferencing.
§

fn deref(&self) -> &<TransactionSigned as Deref>::Target

Dereferences the value.
§

impl<'de> Deserialize<'de> for TransactionSigned

§

fn deserialize<__D>( __deserializer: __D, ) -> Result<TransactionSigned, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl<'de> DeserializeAs<'de, TransactionSigned> for TransactionSigned<'de>

§

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

Deserialize this value from the given Serde deserializer.
§

impl Encodable for TransactionSigned

§

fn encode(&self, out: &mut dyn BufMut)

This encodes the transaction with the signature, and an rlp header.

For legacy transactions, it encodes the transaction data: rlp(tx-data)

For EIP-2718 typed transactions, it encodes the transaction type followed by the rlp of the transaction: rlp(tx-type || rlp(tx-data))

§

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes. Read more
§

impl Encodable2718 for TransactionSigned

§

fn type_flag(&self) -> Option<u8>

Return the type flag (if any). Read more
§

fn encode_2718_len(&self) -> usize

The length of the 2718 encoded envelope. This is the length of the type flag + the length of the inner encoding.
§

fn encode_2718(&self, out: &mut dyn BufMut)

Encode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction. Read more
§

fn is_legacy(&self) -> bool

True if the envelope is the legacy variant.
§

fn encoded_2718(&self) -> Vec<u8>

Encode the transaction according to [EIP-2718] rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction. Read more
§

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

Compute the hash as committed to in the MPT trie. This hash is used ONLY by the Ethereum merkle-patricia trie and associated proofs. Do not call this method unless you are building a full or light client. Read more
§

fn seal(self) -> Sealed<Self>

Seal the encodable, by encoding and hashing it.
§

fn network_len(&self) -> usize

The length of the 2718 encoded envelope in network format. This is the length of the header + the length of the type flag and inner encoding.
§

fn network_encode(&self, out: &mut dyn BufMut)

Encode in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client. Read more
§

impl FillTxEnv for TransactionSigned

§

fn fill_tx_env(&self, tx_env: &mut TxEnv, sender: Address)

Fills TxEnv with an Address and transaction.
§

impl FillTxEnv for TransactionSigned

§

fn fill_tx_env(&self, tx_env: &mut TxEnv, sender: Address)

Fills TxEnv with an Address and transaction.
§

impl<'a> From<&'a TransactionSigned> for TransactionSigned<'a>

§

fn from(value: &'a TransactionSigned) -> TransactionSigned<'a>

Converts to this type from the input type.
§

impl<'a> From<TransactionSigned<'a>> for TransactionSigned

§

fn from(value: TransactionSigned<'a>) -> TransactionSigned

Converts to this type from the input type.
§

impl From<TransactionSigned> for TransactionSignedNoHash

§

fn from(tx: TransactionSigned) -> TransactionSignedNoHash

Converts to this type from the input type.
§

impl From<TransactionSigned> for TransactionSignedVariant

§

fn from(value: TransactionSigned) -> TransactionSignedVariant

Converts to this type from the input type.
§

impl From<TransactionSignedEcRecovered> for TransactionSigned

§

fn from(recovered: TransactionSignedEcRecovered) -> TransactionSigned

Converts to this type from the input type.
§

impl From<TransactionSignedNoHash> for TransactionSigned

§

fn from(tx: TransactionSignedNoHash) -> TransactionSigned

Converts to this type from the input type.
§

impl Hash for TransactionSigned

§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl InMemorySize for TransactionSigned

§

fn size(&self) -> usize

Calculate a heuristic for the in-memory size of the TransactionSigned.

§

impl PartialEq for TransactionSigned

§

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

§

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 SerializeAs<TransactionSigned> for TransactionSigned<'_>

§

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

Serialize this value into the given Serde serializer.
§

impl SignedTransaction for TransactionSigned

§

type Transaction = Transaction

Unsigned transaction type.
§

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

Returns reference to transaction hash.
§

fn transaction(&self) -> &<TransactionSigned as SignedTransaction>::Transaction

Returns reference to transaction.
§

fn signature(&self) -> &PrimitiveSignature

Returns reference to signature.
§

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

Recover signer from signature and hash. Read more
§

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

Recover signer from signature and hash without ensuring that the signature has a low s value. Read more
§

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

Calculate transaction hash, eip2728 transaction does not contain rlp header and start with tx type.
§

impl Transaction for TransactionSigned

§

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

Get chain_id.
§

fn nonce(&self) -> u64

Get nonce.
§

fn gas_limit(&self) -> u64

Get gas_limit.
§

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

Get gas_price.
§

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

Max fee per blob gas for EIP-4844 transaction. Read more
§

fn priority_fee_or_price(&self) -> u128

Return the max priority fee per gas if the transaction is an EIP-1559 transaction, and otherwise return the gas price. Read more
§

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

Returns the effective gas price for the given base fee. Read more
§

fn is_dynamic_fee(&self) -> bool

Returns true if the transaction supports dynamic fees.
§

fn kind(&self) -> TxKind

Returns the transaction kind.
§

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

Get value.
§

fn input(&self) -> &Bytes

Get data.
§

fn ty(&self) -> u8

Returns the transaction type
§

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

Returns the EIP-2930 access_list for the particular transaction type. Returns None for older transaction types.
§

fn blob_versioned_hashes(&self) -> Option<&[FixedBytes<32>]>

Blob versioned hashes for eip4844 transaction. For previous transaction types this is None.
§

fn authorization_list(&self) -> Option<&[SignedAuthorization]>

Returns the SignedAuthorization list of the transaction. Read more
§

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

Returns the effective tip for this transaction. Read more
§

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. Read more
§

impl TryFrom<TransactionSigned> for PooledTransactionsElement

§

type Error = TransactionConversionError

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

fn try_from( tx: TransactionSigned, ) -> Result<PooledTransactionsElement, <PooledTransactionsElement as TryFrom<TransactionSigned>>::Error>

Performs the conversion.
§

impl TryFrom<WithOtherFields<Transaction<AnyTxEnvelope>>> for TransactionSigned

§

type Error = ConversionError

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

fn try_from( tx: WithOtherFields<Transaction<AnyTxEnvelope>>, ) -> Result<TransactionSigned, <TransactionSigned as TryFrom<WithOtherFields<Transaction<AnyTxEnvelope>>>>::Error>

Performs the conversion.
§

impl Eq for TransactionSigned

§

impl StructuralPartialEq for TransactionSigned

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types #44874)
Available on non-bootstrap only.
The target type on which the method may be called.
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<A> ArbInterop for A
where A: for<'a> Arbitrary<'a> + 'static + Debug + Clone,

Source§

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

§

impl<T> Eip2718Envelope for T
where T: Decodable2718 + Encodable2718,

§

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

§

impl<T> FullSignedTx for T
where T: SignedTransaction + FillTxEnv + MaybeCompact, <T as SignedTransaction>::Transaction: FullTransaction,

§

impl<T> MaybeArbitrary for T
where T: for<'a> Arbitrary<'a>,

§

impl<T> MaybeCompact for T
where T: Compact,

§

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> NippyJarHeader for T
where T: Send + Sync + Serialize + for<'b> Deserialize<'b> + Debug + 'static,

§

impl<T> RpcObject for T
where T: RpcParam + RpcReturn,

§

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

§

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

§

impl<T> Value for T
where T: Compress + Decompress + Serialize,

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