pub struct AA2dPool {
submission_id: u64,
independent_transactions: HashMap<AASequenceId, PendingTransaction<CoinbaseTipOrdering<TempoPooledTransaction>>>,
by_id: BTreeMap<AA2dTransactionId, AA2dInternalTransaction>,
by_hash: HashMap<TxHash, Arc<ValidPoolTransaction<TempoPooledTransaction>>>,
address_slots: HashMap<U256, (Address, U256)>,
config: AA2dPoolConfig,
metrics: AA2dPoolMetrics,
}Expand description
A sub-pool that keeps track of 2D nonce transactions.
It maintains both pending and queued transactions.
A 2d nonce transaction is pending if it dosn’t have a nonce gap for its nonce key, and is queued if its nonce key set has nonce gaps.
This pool relies on state changes to track the nonces.
§Limitations
- We assume new AA transactions either create a new nonce key (nonce 0) or use an existing nonce key. To keep track of the known keys by accounts this pool relies on state changes to promote transactions to pending.
Fields§
§submission_id: u64Keeps track of transactions inserted in the pool.
This way we can determine when transactions were submitted to the pool.
independent_transactions: HashMap<AASequenceId, PendingTransaction<CoinbaseTipOrdering<TempoPooledTransaction>>>independent, pending, executable transactions, one per sequence id.
by_id: BTreeMap<AA2dTransactionId, AA2dInternalTransaction>All transactions that are currently inside the pool grouped by their unique identifier.
by_hash: HashMap<TxHash, Arc<ValidPoolTransaction<TempoPooledTransaction>>>All transactions by hash.
address_slots: HashMap<U256, (Address, U256)>Reverse index for the storage slot of an account’s nonce
mapping(address => mapping(uint256 => uint64)) public noncesThis identifies the account and nonce key based on the slot in the NonceManager.
config: AA2dPoolConfigSettings for this sub-pool.
metrics: AA2dPoolMetricsMetrics for tracking pool statistics
Implementations§
Source§impl AA2dPool
impl AA2dPool
Sourcepub fn new(config: AA2dPoolConfig) -> Self
pub fn new(config: AA2dPoolConfig) -> Self
Creates a new instance with the givenconfig and nonce keys
Sourcefn update_metrics(&self)
fn update_metrics(&self)
Updates all metrics to reflect the current state of the pool
Sourcepub(crate) fn add_transaction(
&mut self,
transaction: Arc<ValidPoolTransaction<TempoPooledTransaction>>,
on_chain_nonce: u64,
) -> PoolResult<AddedTransaction<TempoPooledTransaction>>
pub(crate) fn add_transaction( &mut self, transaction: Arc<ValidPoolTransaction<TempoPooledTransaction>>, on_chain_nonce: u64, ) -> PoolResult<AddedTransaction<TempoPooledTransaction>>
Entrypoint for adding a 2d AA transaction.
on_chain_nonce is expected to be the nonce of the sender at the time of validation.
If transaction is using 2D nonces, this is expected to be the nonce corresponding
to the transaction’s nonce key.
Sourcepub(crate) fn pending_and_queued_txn_count(&self) -> (usize, usize)
pub(crate) fn pending_and_queued_txn_count(&self) -> (usize, usize)
Returns how many pending and queued transactions are in the pool.
Sourcepub(crate) fn get_transactions_by_origin_iter(
&self,
origin: TransactionOrigin,
) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn get_transactions_by_origin_iter( &self, origin: TransactionOrigin, ) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Returns all transactions that where submitted with the given [TransactionOrigin]
Sourcepub(crate) fn get_pending_transactions_by_origin_iter(
&self,
origin: TransactionOrigin,
) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn get_pending_transactions_by_origin_iter( &self, origin: TransactionOrigin, ) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Returns all transactions that where submitted with the given [TransactionOrigin]
Sourcepub(crate) fn get_transactions_by_sender_iter(
&self,
sender: Address,
) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn get_transactions_by_sender_iter( &self, sender: Address, ) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Returns all transactions of the address
Sourcepub(crate) fn all_transaction_hashes_iter(&self) -> impl Iterator<Item = TxHash>
pub(crate) fn all_transaction_hashes_iter(&self) -> impl Iterator<Item = TxHash>
Returns an iterator over all transaction hashes in this pool
Sourcepub(crate) fn queued_transactions(
&self,
) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn queued_transactions( &self, ) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Returns all transactions from that are queued.
Sourcepub(crate) fn pending_transactions(
&self,
) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn pending_transactions( &self, ) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Returns all transactions that are pending.
Sourcepub(crate) fn best_transactions(&self) -> BestAA2dTransactions ⓘ
pub(crate) fn best_transactions(&self) -> BestAA2dTransactions ⓘ
Returns the best, executable transactions for this sub-pool
Sourcepub(crate) fn get(
&self,
tx_hash: &TxHash,
) -> Option<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn get( &self, tx_hash: &TxHash, ) -> Option<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Returns the transaction by hash.
Sourcepub(crate) fn get_all<'a, I>(
&self,
tx_hashes: I,
) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>where
I: Iterator<Item = &'a TxHash> + 'a,
pub(crate) fn get_all<'a, I>(
&self,
tx_hashes: I,
) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>where
I: Iterator<Item = &'a TxHash> + 'a,
Returns the transaction by hash.
Sourcepub(crate) fn get_all_iter<'a, I>(
&'a self,
tx_hashes: I,
) -> impl Iterator<Item = &'a Arc<ValidPoolTransaction<TempoPooledTransaction>>> + 'awhere
I: IntoIterator<Item = &'a TxHash> + 'a,
pub(crate) fn get_all_iter<'a, I>(
&'a self,
tx_hashes: I,
) -> impl Iterator<Item = &'a Arc<ValidPoolTransaction<TempoPooledTransaction>>> + 'awhere
I: IntoIterator<Item = &'a TxHash> + 'a,
Returns an iterator over all the matching transactions.
Sourcepub(crate) fn senders_iter(&self) -> impl Iterator<Item = &Address>
pub(crate) fn senders_iter(&self) -> impl Iterator<Item = &Address>
Returns an iterator over all senders in this pool.
Sourcefn descendant_txs_mut<'a, 'b: 'a>(
&'a mut self,
id: &'b AA2dTransactionId,
) -> impl Iterator<Item = (&'a AA2dTransactionId, &'a mut AA2dInternalTransaction)> + 'a
fn descendant_txs_mut<'a, 'b: 'a>( &'a mut self, id: &'b AA2dTransactionId, ) -> impl Iterator<Item = (&'a AA2dTransactionId, &'a mut AA2dInternalTransaction)> + 'a
Returns all mutable transactions that follow after the given id but have the same sender.
NOTE: The range is inclusive: if the transaction that belongs to id it field be the
first value.
Sourcefn descendant_txs_exclusive<'a, 'b: 'a>(
&'a self,
id: &'b AA2dTransactionId,
) -> impl Iterator<Item = (&'a AA2dTransactionId, &'a AA2dInternalTransaction)> + 'a
fn descendant_txs_exclusive<'a, 'b: 'a>( &'a self, id: &'b AA2dTransactionId, ) -> impl Iterator<Item = (&'a AA2dTransactionId, &'a AA2dInternalTransaction)> + 'a
Returns all transactions that follow after the given id and have the same sender.
NOTE: The range is exclusive
Sourcefn remove_transaction_by_id(
&mut self,
id: &AA2dTransactionId,
) -> Option<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
fn remove_transaction_by_id( &mut self, id: &AA2dTransactionId, ) -> Option<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Removes the transaction with the given id from all sets.
This does not shift the independent transaction forward or mark descendants as pending.
Sourcefn remove_independent(
&mut self,
id: &AA2dTransactionId,
) -> Option<PendingTransaction<CoinbaseTipOrdering<TempoPooledTransaction>>>
fn remove_independent( &mut self, id: &AA2dTransactionId, ) -> Option<PendingTransaction<CoinbaseTipOrdering<TempoPooledTransaction>>>
Removes the independent transaction if it matches the given id.
Sourcepub(crate) fn remove_transactions<'a, I>(
&mut self,
tx_hashes: I,
) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>where
I: Iterator<Item = &'a TxHash> + 'a,
pub(crate) fn remove_transactions<'a, I>(
&mut self,
tx_hashes: I,
) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>where
I: Iterator<Item = &'a TxHash> + 'a,
Removes the transaction by its hash from all internal sets.
Sourcefn remove_transaction_by_hash(
&mut self,
tx_hash: &B256,
) -> Option<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
fn remove_transaction_by_hash( &mut self, tx_hash: &B256, ) -> Option<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Removes the transaction by its hash from all internal sets.
This does not shift the independent transaction forward or mark descendants as pending.
Sourcepub(crate) fn remove_transactions_and_descendants<'a, I>(
&mut self,
hashes: I,
) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>where
I: Iterator<Item = &'a TxHash> + 'a,
pub(crate) fn remove_transactions_and_descendants<'a, I>(
&mut self,
hashes: I,
) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>where
I: Iterator<Item = &'a TxHash> + 'a,
Removes and returns all matching transactions and their dependent transactions from the pool.
Sourcepub(crate) fn remove_transactions_by_sender(
&mut self,
sender_id: Address,
) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn remove_transactions_by_sender( &mut self, sender_id: Address, ) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Removes all transactions from the given sender.
Sourcefn remove_descendants(
&mut self,
tx: &AA2dTransactionId,
removed: &mut Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>,
)
fn remove_descendants( &mut self, tx: &AA2dTransactionId, removed: &mut Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>, )
Removes only the descendants of the given transaction from this pool.
All removed transactions are added to the removed vec.
Sourcepub(crate) fn on_nonce_changes(
&mut self,
on_chain_ids: HashMap<AASequenceId, u64>,
) -> (Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>, Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>)
pub(crate) fn on_nonce_changes( &mut self, on_chain_ids: HashMap<AASequenceId, u64>, ) -> (Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>, Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>)
Updates the internal state based on the state changes of the NonceManager [NONCE_PRECOMPILE_ADDRESS].
This takes a vec of changed AASequenceId with their current on chain nonce.
This will prune mined transactions and promote unblocked transactions if any, returns (promoted, mined)
Sourcefn discard(&mut self) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
fn discard(&mut self) -> Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Removes stale transactions if the pool is above capacity.
Sourcepub fn metrics(&self) -> &AA2dPoolMetrics
pub fn metrics(&self) -> &AA2dPoolMetrics
Returns a reference to the metrics for this pool
Sourcepub(crate) fn contains(&self, tx_hash: &TxHash) -> bool
pub(crate) fn contains(&self, tx_hash: &TxHash) -> bool
Returns true if the transaction with the given hash is already included in this pool.
Sourcepub(crate) fn pooled_transactions_hashes_iter(
&self,
) -> impl Iterator<Item = TxHash>
pub(crate) fn pooled_transactions_hashes_iter( &self, ) -> impl Iterator<Item = TxHash>
Returns hashes of transactions in the pool that can be propagated.
Sourcepub(crate) fn pooled_transactions_iter(
&self,
) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
pub(crate) fn pooled_transactions_iter( &self, ) -> impl Iterator<Item = Arc<ValidPoolTransaction<TempoPooledTransaction>>>
Returns transactions in the pool that can be propagated
const fn next_id(&mut self) -> u64
Sourcefn record_2d_slot(&mut self, transaction: &TempoPooledTransaction)
fn record_2d_slot(&mut self, transaction: &TempoPooledTransaction)
Caches the 2D nonce key slot for the given sender and nonce key.
Sourcepub(crate) fn on_state_updates(
&mut self,
state: &HashMap<Address, BundleAccount>,
) -> (Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>, Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>)
pub(crate) fn on_state_updates( &mut self, state: &HashMap<Address, BundleAccount>, ) -> (Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>, Vec<Arc<ValidPoolTransaction<TempoPooledTransaction>>>)
Processes state updates and updates internal state accordingly.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for AA2dPool
impl !RefUnwindSafe for AA2dPool
impl Send for AA2dPool
impl Sync for AA2dPool
impl Unpin for AA2dPool
impl !UnwindSafe for AA2dPool
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
§impl<T> Conv for T
impl<T> Conv for T
§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<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
§fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
TxEnv] from a transaction and a sender address.§impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
§fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
TxEnv] from a transaction, its sender, and encoded transaction bytes.§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> 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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Layered].§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> ServiceExt for T
impl<T> ServiceExt for T
§fn propagate_header(self, header: HeaderName) -> PropagateHeader<Self>where
Self: Sized,
fn propagate_header(self, header: HeaderName) -> PropagateHeader<Self>where
Self: Sized,
propagate-header only.§fn add_extension<T>(self, value: T) -> AddExtension<Self, T>where
Self: Sized,
fn add_extension<T>(self, value: T) -> AddExtension<Self, T>where
Self: Sized,
add-extension only.§fn map_request_body<F>(self, f: F) -> MapRequestBody<Self, F>where
Self: Sized,
fn map_request_body<F>(self, f: F) -> MapRequestBody<Self, F>where
Self: Sized,
map-request-body only.§fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
map-response-body only.§fn compression(self) -> Compression<Self>where
Self: Sized,
fn compression(self) -> Compression<Self>where
Self: Sized,
compression-br or compression-deflate or compression-gzip or compression-zstd only.§fn decompression(self) -> Decompression<Self>where
Self: Sized,
fn decompression(self) -> Decompression<Self>where
Self: Sized,
decompression-br or decompression-deflate or decompression-gzip or decompression-zstd only.§fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
trace only.§fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
trace only.§fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
follow-redirect only.§fn sensitive_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<SetSensitiveResponseHeaders<Self>>where
Self: Sized,
fn sensitive_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<SetSensitiveResponseHeaders<Self>>where
Self: Sized,
sensitive-headers only.§fn sensitive_request_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<Self>where
Self: Sized,
fn sensitive_request_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveRequestHeaders<Self>where
Self: Sized,
sensitive-headers only.§fn sensitive_response_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveResponseHeaders<Self>where
Self: Sized,
fn sensitive_response_headers(
self,
headers: impl IntoIterator<Item = HeaderName>,
) -> SetSensitiveResponseHeaders<Self>where
Self: Sized,
sensitive-headers only.§fn override_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
fn override_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
set-header only.§fn append_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
fn append_request_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
set-header only.§fn insert_request_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
fn insert_request_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetRequestHeader<Self, M>where
Self: Sized,
set-header only.§fn override_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
fn override_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
set-header only.§fn append_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
fn append_response_header<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
set-header only.§fn insert_response_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
fn insert_response_header_if_not_present<M>(
self,
header_name: HeaderName,
make: M,
) -> SetResponseHeader<Self, M>where
Self: Sized,
set-header only.§fn set_request_id<M>(
self,
header_name: HeaderName,
make_request_id: M,
) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
fn set_request_id<M>(
self,
header_name: HeaderName,
make_request_id: M,
) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
request-id only.§fn set_x_request_id<M>(self, make_request_id: M) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
fn set_x_request_id<M>(self, make_request_id: M) -> SetRequestId<Self, M>where
Self: Sized,
M: MakeRequestId,
request-id only.x-request-id as the header name. Read more§fn propagate_request_id(
self,
header_name: HeaderName,
) -> PropagateRequestId<Self>where
Self: Sized,
fn propagate_request_id(
self,
header_name: HeaderName,
) -> PropagateRequestId<Self>where
Self: Sized,
request-id only.§fn propagate_x_request_id(self) -> PropagateRequestId<Self>where
Self: Sized,
fn propagate_x_request_id(self) -> PropagateRequestId<Self>where
Self: Sized,
request-id only.x-request-id as the header name. Read more§fn catch_panic(self) -> CatchPanic<Self, DefaultResponseForPanic>where
Self: Sized,
fn catch_panic(self) -> CatchPanic<Self, DefaultResponseForPanic>where
Self: Sized,
catch-panic only.500 Internal Server responses. Read more§fn request_body_limit(self, limit: usize) -> RequestBodyLimit<Self>where
Self: Sized,
fn request_body_limit(self, limit: usize) -> RequestBodyLimit<Self>where
Self: Sized,
limit only.413 Payload Too Large responses. Read more§fn trim_trailing_slash(self) -> NormalizePath<Self>where
Self: Sized,
fn trim_trailing_slash(self) -> NormalizePath<Self>where
Self: Sized,
normalize-path only.§fn append_trailing_slash(self) -> NormalizePath<Self>where
Self: Sized,
fn append_trailing_slash(self) -> NormalizePath<Self>where
Self: Sized,
normalize-path only.§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<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
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