Struct WithOtherFields
pub struct WithOtherFields<T> {
pub inner: T,
pub other: OtherFields,
}
Expand description
An extension to a struct that allows to capture additional fields when deserializing.
See OtherFields
for more information.
Fields§
§inner: T
The inner struct.
other: OtherFields
All fields not present in the inner struct.
Implementations§
§impl<T> WithOtherFields<T>
impl<T> WithOtherFields<T>
pub fn new(inner: T) -> WithOtherFields<T>
pub fn new(inner: T) -> WithOtherFields<T>
Creates a new WithOtherFields
instance.
Trait Implementations§
§impl<'arbitrary, T> Arbitrary<'arbitrary> for WithOtherFields<T>where
T: Arbitrary<'arbitrary>,
impl<'arbitrary, T> Arbitrary<'arbitrary> for WithOtherFields<T>where
T: Arbitrary<'arbitrary>,
§fn arbitrary(
u: &mut Unstructured<'arbitrary>,
) -> Result<WithOtherFields<T>, Error>
fn arbitrary( u: &mut Unstructured<'arbitrary>, ) -> Result<WithOtherFields<T>, Error>
Self
from the given unstructured data. Read more§fn arbitrary_take_rest(
u: Unstructured<'arbitrary>,
) -> Result<WithOtherFields<T>, Error>
fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<WithOtherFields<T>, 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<T, U> AsRef<U> for WithOtherFields<T>where
T: AsRef<U>,
impl<T, U> AsRef<U> for WithOtherFields<T>where
T: AsRef<U>,
§impl<T> BlockHeader for WithOtherFields<T>where
T: BlockHeader,
Available on crate feature serde
only.
impl<T> BlockHeader for WithOtherFields<T>where
T: BlockHeader,
serde
only.§fn parent_hash(&self) -> FixedBytes<32>
fn parent_hash(&self) -> FixedBytes<32>
§fn ommers_hash(&self) -> FixedBytes<32>
fn ommers_hash(&self) -> FixedBytes<32>
§fn beneficiary(&self) -> Address
fn beneficiary(&self) -> Address
§fn state_root(&self) -> FixedBytes<32>
fn state_root(&self) -> FixedBytes<32>
§fn transactions_root(&self) -> FixedBytes<32>
fn transactions_root(&self) -> FixedBytes<32>
§fn receipts_root(&self) -> FixedBytes<32>
fn receipts_root(&self) -> FixedBytes<32>
§fn withdrawals_root(&self) -> Option<FixedBytes<32>>
fn withdrawals_root(&self) -> Option<FixedBytes<32>>
§fn logs_bloom(&self) -> Bloom
fn logs_bloom(&self) -> Bloom
§fn difficulty(&self) -> Uint<256, 4>
fn difficulty(&self) -> Uint<256, 4>
§fn extra_data(&self) -> &Bytes
fn extra_data(&self) -> &Bytes
§fn mix_hash(&self) -> Option<FixedBytes<32>>
fn mix_hash(&self) -> Option<FixedBytes<32>>
§fn nonce(&self) -> Option<FixedBytes<8>>
fn nonce(&self) -> Option<FixedBytes<8>>
§fn base_fee_per_gas(&self) -> Option<u64>
fn base_fee_per_gas(&self) -> Option<u64>
§fn blob_gas_used(&self) -> Option<u64>
fn blob_gas_used(&self) -> Option<u64>
§fn excess_blob_gas(&self) -> Option<u64>
fn excess_blob_gas(&self) -> Option<u64>
§fn parent_beacon_block_root(&self) -> Option<FixedBytes<32>>
fn parent_beacon_block_root(&self) -> Option<FixedBytes<32>>
§fn requests_hash(&self) -> Option<FixedBytes<32>>
fn requests_hash(&self) -> Option<FixedBytes<32>>
§fn next_block_excess_blob_gas(&self) -> Option<u64>
fn next_block_excess_blob_gas(&self) -> Option<u64>
§fn next_block_blob_fee(&self) -> Option<u128>
fn next_block_blob_fee(&self) -> Option<u128>
§impl<T> BlockResponse for WithOtherFields<T>where
T: BlockResponse,
impl<T> BlockResponse for WithOtherFields<T>where
T: BlockResponse,
§type Transaction = <T as BlockResponse>::Transaction
type Transaction = <T as BlockResponse>::Transaction
§fn header(&self) -> &<WithOtherFields<T> as BlockResponse>::Header
fn header(&self) -> &<WithOtherFields<T> as BlockResponse>::Header
§fn transactions(
&self,
) -> &BlockTransactions<<WithOtherFields<T> as BlockResponse>::Transaction>
fn transactions( &self, ) -> &BlockTransactions<<WithOtherFields<T> as BlockResponse>::Transaction>
§fn transactions_mut(
&mut self,
) -> &mut BlockTransactions<<WithOtherFields<T> as BlockResponse>::Transaction>
fn transactions_mut( &mut self, ) -> &mut BlockTransactions<<WithOtherFields<T> as BlockResponse>::Transaction>
§fn other_fields(&self) -> Option<&OtherFields>
fn other_fields(&self) -> Option<&OtherFields>
other
field from WithOtherFields
type.§impl<T> Clone for WithOtherFields<T>where
T: Clone,
impl<T> Clone for WithOtherFields<T>where
T: Clone,
§fn clone(&self) -> WithOtherFields<T>
fn clone(&self) -> WithOtherFields<T>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<T> Debug for WithOtherFields<T>where
T: Debug,
impl<T> Debug for WithOtherFields<T>where
T: Debug,
§impl<T> Default for WithOtherFields<T>where
T: Default,
impl<T> Default for WithOtherFields<T>where
T: Default,
§fn default() -> WithOtherFields<T>
fn default() -> WithOtherFields<T>
§impl<T> Deref for WithOtherFields<T>
impl<T> Deref for WithOtherFields<T>
§impl<T> DerefMut for WithOtherFields<T>
impl<T> DerefMut for WithOtherFields<T>
§fn deref_mut(&mut self) -> &mut <WithOtherFields<T> as Deref>::Target
fn deref_mut(&mut self) -> &mut <WithOtherFields<T> as Deref>::Target
§impl<'de, T> Deserialize<'de> for WithOtherFields<T>where
T: Deserialize<'de> + Serialize,
impl<'de, T> Deserialize<'de> for WithOtherFields<T>where
T: Deserialize<'de> + Serialize,
§fn deserialize<D>(
deserializer: D,
) -> Result<WithOtherFields<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<WithOtherFields<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
§impl From<AnyTxEnvelope> for WithOtherFields<TransactionRequest>
impl From<AnyTxEnvelope> for WithOtherFields<TransactionRequest>
§fn from(value: AnyTxEnvelope) -> WithOtherFields<TransactionRequest>
fn from(value: AnyTxEnvelope) -> WithOtherFields<TransactionRequest>
§impl From<AnyTypedTransaction> for WithOtherFields<TransactionRequest>
impl From<AnyTypedTransaction> for WithOtherFields<TransactionRequest>
§fn from(value: AnyTypedTransaction) -> WithOtherFields<TransactionRequest>
fn from(value: AnyTypedTransaction) -> WithOtherFields<TransactionRequest>
§impl From<Block> for WithOtherFields<Block>
Available on crate feature serde
only.
impl From<Block> for WithOtherFields<Block>
serde
only.§fn from(inner: Block) -> WithOtherFields<Block>
fn from(inner: Block) -> WithOtherFields<Block>
§impl From<Header> for WithOtherFields<Header>
Available on crate feature serde
only.
impl From<Header> for WithOtherFields<Header>
serde
only.§fn from(inner: Header) -> WithOtherFields<Header>
fn from(inner: Header) -> WithOtherFields<Header>
§impl<T> From<TxEnvelope> for WithOtherFields<T>where
T: From<TxEnvelope>,
Available on crate feature serde
only.
impl<T> From<TxEnvelope> for WithOtherFields<T>where
T: From<TxEnvelope>,
serde
only.§fn from(value: TxEnvelope) -> WithOtherFields<T>
fn from(value: TxEnvelope) -> WithOtherFields<T>
§impl<T> From<TypedTransaction> for WithOtherFields<T>where
T: From<TypedTransaction>,
Available on crate feature serde
only.
impl<T> From<TypedTransaction> for WithOtherFields<T>where
T: From<TypedTransaction>,
serde
only.§fn from(value: TypedTransaction) -> WithOtherFields<T>
fn from(value: TypedTransaction) -> WithOtherFields<T>
§impl<T> HeaderResponse for WithOtherFields<T>where
T: HeaderResponse,
impl<T> HeaderResponse for WithOtherFields<T>where
T: HeaderResponse,
§fn hash(&self) -> FixedBytes<32>
fn hash(&self) -> FixedBytes<32>
§impl<T> PartialEq for WithOtherFields<T>where
T: PartialEq,
impl<T> PartialEq for WithOtherFields<T>where
T: PartialEq,
§impl<T> ReceiptResponse for WithOtherFields<T>where
T: ReceiptResponse,
impl<T> ReceiptResponse for WithOtherFields<T>where
T: ReceiptResponse,
§fn contract_address(&self) -> Option<Address>
fn contract_address(&self) -> Option<Address>
None
if the transaction was not a deployment.§fn block_hash(&self) -> Option<FixedBytes<32>>
fn block_hash(&self) -> Option<FixedBytes<32>>
§fn block_number(&self) -> Option<u64>
fn block_number(&self) -> Option<u64>
§fn transaction_hash(&self) -> FixedBytes<32>
fn transaction_hash(&self) -> FixedBytes<32>
§fn transaction_index(&self) -> Option<u64>
fn transaction_index(&self) -> Option<u64>
§fn effective_gas_price(&self) -> u128
fn effective_gas_price(&self) -> u128
§fn blob_gas_used(&self) -> Option<u128>
fn blob_gas_used(&self) -> Option<u128>
§fn blob_gas_price(&self) -> Option<u128>
fn blob_gas_price(&self) -> Option<u128>
§fn cumulative_gas_used(&self) -> u128
fn cumulative_gas_used(&self) -> u128
§fn state_root(&self) -> Option<FixedBytes<32>>
fn state_root(&self) -> Option<FixedBytes<32>>
§impl<T> Serialize for WithOtherFields<T>where
T: Serialize,
impl<T> Serialize for WithOtherFields<T>where
T: Serialize,
§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<T> Transaction for WithOtherFields<T>where
T: Transaction,
Available on crate feature serde
only.
impl<T> Transaction for WithOtherFields<T>where
T: Transaction,
serde
only.§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 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§fn is_dynamic_fee(&self) -> bool
fn is_dynamic_fee(&self) -> bool
true
if the transaction supports dynamic fees.§impl TransactionBuilder<AnyNetwork> for WithOtherFields<TransactionRequest>
impl TransactionBuilder<AnyNetwork> for WithOtherFields<TransactionRequest>
§fn access_list(&self) -> Option<&AccessList>
fn access_list(&self) -> Option<&AccessList>
Get the EIP-2930 access list for the transaction.
§fn set_access_list(&mut self, access_list: AccessList)
fn set_access_list(&mut self, access_list: AccessList)
Sets the EIP-2930 access list.
§fn set_chain_id(&mut self, chain_id: u64)
fn set_chain_id(&mut self, chain_id: u64)
§fn clear_kind(&mut self)
fn clear_kind(&mut self)
§fn set_gas_price(&mut self, gas_price: u128)
fn set_gas_price(&mut self, gas_price: u128)
§fn max_fee_per_gas(&self) -> Option<u128>
fn max_fee_per_gas(&self) -> Option<u128>
§fn set_max_fee_per_gas(&mut self, max_fee_per_gas: u128)
fn set_max_fee_per_gas(&mut self, max_fee_per_gas: u128)
§fn max_priority_fee_per_gas(&self) -> Option<u128>
fn max_priority_fee_per_gas(&self) -> Option<u128>
§fn set_max_priority_fee_per_gas(&mut self, max_priority_fee_per_gas: u128)
fn set_max_priority_fee_per_gas(&mut self, max_priority_fee_per_gas: u128)
§fn set_gas_limit(&mut self, gas_limit: u64)
fn set_gas_limit(&mut self, gas_limit: u64)
§fn complete_type(
&self,
ty: <AnyNetwork as Network>::TxType,
) -> Result<(), Vec<&'static str>>
fn complete_type( &self, ty: <AnyNetwork as Network>::TxType, ) -> Result<(), Vec<&'static str>>
§fn can_submit(&self) -> bool
fn can_submit(&self) -> bool
eth_sendTransaction
endpoint.§fn can_build(&self) -> bool
fn can_build(&self) -> bool
§fn output_tx_type(&self) -> <AnyNetwork as Network>::TxType
fn output_tx_type(&self) -> <AnyNetwork as Network>::TxType
§fn output_tx_type_checked(&self) -> Option<<AnyNetwork as Network>::TxType>
fn output_tx_type_checked(&self) -> Option<<AnyNetwork as Network>::TxType>
None
if
the builder is not ready to build.§fn prep_for_submission(&mut self)
fn prep_for_submission(&mut self)
§fn build_unsigned(
self,
) -> Result<<AnyNetwork as Network>::UnsignedTx, UnbuiltTransactionError<AnyNetwork>>
fn build_unsigned( self, ) -> Result<<AnyNetwork as Network>::UnsignedTx, UnbuiltTransactionError<AnyNetwork>>
§async fn build<W>(
self,
wallet: &W,
) -> Result<<AnyNetwork as Network>::TxEnvelope, TransactionBuilderError<AnyNetwork>>where
W: NetworkWallet<AnyNetwork>,
async fn build<W>(
self,
wallet: &W,
) -> Result<<AnyNetwork as Network>::TxEnvelope, TransactionBuilderError<AnyNetwork>>where
W: NetworkWallet<AnyNetwork>,
§fn with_chain_id(self, chain_id: u64) -> Self
fn with_chain_id(self, chain_id: u64) -> Self
§fn with_nonce(self, nonce: u64) -> Self
fn with_nonce(self, nonce: u64) -> Self
§fn with_input<T>(self, input: T) -> Self
fn with_input<T>(self, input: T) -> Self
§fn with_kind(self, kind: TxKind) -> Self
fn with_kind(self, kind: TxKind) -> Self
§fn set_create(&mut self)
fn set_create(&mut self)
to
field to a create call.§fn into_create(self) -> Self
fn into_create(self) -> Self
to
field to a create call.§fn set_deploy_code<T>(&mut self, code: T)
fn set_deploy_code<T>(&mut self, code: T)
to
field to TxKind::Create
.§fn with_deploy_code<T>(self, code: T) -> Self
fn with_deploy_code<T>(self, code: T) -> Self
to
field to TxKind::Create
.§fn set_call<T>(&mut self, t: &T)where
T: SolCall,
fn set_call<T>(&mut self, t: &T)where
T: SolCall,
to
field
if it is set to TxKind::Create
.§fn calculate_create_address(&self) -> Option<Address>
fn calculate_create_address(&self) -> Option<Address>
§fn with_value(self, value: Uint<256, 4>) -> Self
fn with_value(self, value: Uint<256, 4>) -> Self
§fn with_gas_price(self, gas_price: u128) -> Self
fn with_gas_price(self, gas_price: u128) -> Self
§fn with_max_fee_per_gas(self, max_fee_per_gas: u128) -> Self
fn with_max_fee_per_gas(self, max_fee_per_gas: u128) -> Self
§fn with_max_priority_fee_per_gas(self, max_priority_fee_per_gas: u128) -> Self
fn with_max_priority_fee_per_gas(self, max_priority_fee_per_gas: u128) -> Self
§fn with_gas_limit(self, gas_limit: u64) -> Self
fn with_gas_limit(self, gas_limit: u64) -> Self
§fn with_access_list(self, access_list: AccessList) -> Self
fn with_access_list(self, access_list: AccessList) -> Self
§fn complete_preferred(&self) -> Result<(), Vec<&'static str>>
fn complete_preferred(&self) -> Result<(), Vec<&'static str>>
§fn assert_preferred(&self, ty: <N as Network>::TxType)
fn assert_preferred(&self, ty: <N as Network>::TxType)
dbg_assert_eq!
to check the builder status, and will have no affect
in release builds.§fn assert_preferred_chained(self, ty: <N as Network>::TxType) -> Self
fn assert_preferred_chained(self, ty: <N as Network>::TxType) -> Self
dbg_assert_eq!
to check the builder status, and will have no affect
in release builds.§impl<T> TransactionBuilder4844 for WithOtherFields<T>where
T: TransactionBuilder4844,
impl<T> TransactionBuilder4844 for WithOtherFields<T>where
T: TransactionBuilder4844,
§fn max_fee_per_blob_gas(&self) -> Option<u128>
fn max_fee_per_blob_gas(&self) -> Option<u128>
§fn set_max_fee_per_blob_gas(&mut self, max_fee_per_blob_gas: u128)
fn set_max_fee_per_blob_gas(&mut self, max_fee_per_blob_gas: u128)
§fn blob_sidecar(&self) -> Option<&BlobTransactionSidecar>
fn blob_sidecar(&self) -> Option<&BlobTransactionSidecar>
§fn set_blob_sidecar(&mut self, sidecar: BlobTransactionSidecar)
fn set_blob_sidecar(&mut self, sidecar: BlobTransactionSidecar)
§fn with_max_fee_per_blob_gas(self, max_fee_per_blob_gas: u128) -> Self
fn with_max_fee_per_blob_gas(self, max_fee_per_blob_gas: u128) -> Self
§fn with_blob_sidecar(self, sidecar: BlobTransactionSidecar) -> Self
fn with_blob_sidecar(self, sidecar: BlobTransactionSidecar) -> Self
§impl<T> TransactionBuilder7702 for WithOtherFields<T>where
T: TransactionBuilder7702,
impl<T> TransactionBuilder7702 for WithOtherFields<T>where
T: TransactionBuilder7702,
§impl<T> TransactionResponse for WithOtherFields<T>where
T: TransactionResponse,
impl<T> TransactionResponse for WithOtherFields<T>where
T: TransactionResponse,
§fn tx_hash(&self) -> FixedBytes<32>
fn tx_hash(&self) -> FixedBytes<32>
§fn block_hash(&self) -> Option<FixedBytes<32>>
fn block_hash(&self) -> Option<FixedBytes<32>>
§fn block_number(&self) -> Option<u64>
fn block_number(&self) -> Option<u64>
§fn transaction_index(&self) -> Option<u64>
fn transaction_index(&self) -> Option<u64>
§fn to(&self) -> Option<Address>
fn to(&self) -> Option<Address>
None
if transaction is a contract creation.§fn gas_price(&self) -> Option<u128>
fn gas_price(&self) -> Option<u128>
max_fee_per_gas
, pre-eip-1559.§fn max_fee_per_gas(&self) -> Option<u128>
fn max_fee_per_gas(&self) -> Option<u128>
gas_price
is used instead.§fn transaction_type(&self) -> Option<u8>
fn transaction_type(&self) -> Option<u8>
§impl TryFrom<WithOtherFields<Block<WithOtherFields<Transaction<AnyTxEnvelope>>, Header<AnyHeader>>>> for Block
impl TryFrom<WithOtherFields<Block<WithOtherFields<Transaction<AnyTxEnvelope>>, Header<AnyHeader>>>> for Block
§type Error = ConversionError
type Error = ConversionError
§fn try_from(
block: WithOtherFields<Block<WithOtherFields<Transaction<AnyTxEnvelope>>, Header<AnyHeader>>>,
) -> Result<Block, <Block as TryFrom<WithOtherFields<Block<WithOtherFields<Transaction<AnyTxEnvelope>>, Header<AnyHeader>>>>>::Error>
fn try_from( block: WithOtherFields<Block<WithOtherFields<Transaction<AnyTxEnvelope>>, Header<AnyHeader>>>, ) -> Result<Block, <Block as TryFrom<WithOtherFields<Block<WithOtherFields<Transaction<AnyTxEnvelope>>, Header<AnyHeader>>>>>::Error>
§impl TryFrom<WithOtherFields<Transaction<AnyTxEnvelope>>> for TransactionSigned
impl TryFrom<WithOtherFields<Transaction<AnyTxEnvelope>>> for TransactionSigned
§type Error = ConversionError
type Error = ConversionError
§fn try_from(
tx: WithOtherFields<Transaction<AnyTxEnvelope>>,
) -> Result<TransactionSigned, <TransactionSigned as TryFrom<WithOtherFields<Transaction<AnyTxEnvelope>>>>::Error>
fn try_from( tx: WithOtherFields<Transaction<AnyTxEnvelope>>, ) -> Result<TransactionSigned, <TransactionSigned as TryFrom<WithOtherFields<Transaction<AnyTxEnvelope>>>>::Error>
impl<T> Eq for WithOtherFields<T>where
T: Eq,
impl<T> StructuralPartialEq for WithOtherFields<T>
Auto Trait Implementations§
impl<T> Freeze for WithOtherFields<T>where
T: Freeze,
impl<T> RefUnwindSafe for WithOtherFields<T>where
T: RefUnwindSafe,
impl<T> Send for WithOtherFields<T>where
T: Send,
impl<T> Sync for WithOtherFields<T>where
T: Sync,
impl<T> Unpin for WithOtherFields<T>where
T: Unpin,
impl<T> UnwindSafe for WithOtherFields<T>where
T: UnwindSafe,
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> Formattable for T
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> Parsable for T
impl<T> RpcObject for Twhere
T: RpcParam + RpcReturn,
impl<T> RpcParam for T
impl<T> RpcReturn for T
Layout§
Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.