Struct Pool
pub struct Pool<V, T, S>where
T: TransactionOrdering,{ /* private fields */ }
Expand description
A shareable, generic, customizable TransactionPool
implementation.
Implementations§
§impl<V, T, S> Pool<V, T, S>where
V: TransactionValidator,
T: TransactionOrdering<Transaction = <V as TransactionValidator>::Transaction>,
S: BlobStore,
impl<V, T, S> Pool<V, T, S>where
V: TransactionValidator,
T: TransactionOrdering<Transaction = <V as TransactionValidator>::Transaction>,
S: BlobStore,
pub fn new(
validator: V,
ordering: T,
blob_store: S,
config: PoolConfig,
) -> Pool<V, T, S>
Available on crate feature test-utils
only.
pub fn new( validator: V, ordering: T, blob_store: S, config: PoolConfig, ) -> Pool<V, T, S>
test-utils
only.Create a new transaction pool instance.
pub fn config(&self) -> &PoolConfig
Available on crate feature test-utils
only.
pub fn config(&self) -> &PoolConfig
test-utils
only.Get the config the pool was configured with.
pub fn len(&self) -> usize
Available on crate feature test-utils
only.
pub fn len(&self) -> usize
test-utils
only.Number of transactions in the entire pool
pub fn is_exceeded(&self) -> bool
Available on crate feature test-utils
only.
pub fn is_exceeded(&self) -> bool
test-utils
only.Returns whether or not the pool is over its configured size and transaction count limits.
§impl<Client, S> Pool<TransactionValidationTaskExecutor<EthTransactionValidator<Client, EthPooledTransaction>>, CoinbaseTipOrdering<EthPooledTransaction>, S>
impl<Client, S> Pool<TransactionValidationTaskExecutor<EthTransactionValidator<Client, EthPooledTransaction>>, CoinbaseTipOrdering<EthPooledTransaction>, S>
pub fn eth_pool(
validator: TransactionValidationTaskExecutor<EthTransactionValidator<Client, EthPooledTransaction>>,
blob_store: S,
config: PoolConfig,
) -> Pool<TransactionValidationTaskExecutor<EthTransactionValidator<Client, EthPooledTransaction>>, CoinbaseTipOrdering<EthPooledTransaction>, S>
Available on crate feature test-utils
only.
pub fn eth_pool( validator: TransactionValidationTaskExecutor<EthTransactionValidator<Client, EthPooledTransaction>>, blob_store: S, config: PoolConfig, ) -> Pool<TransactionValidationTaskExecutor<EthTransactionValidator<Client, EthPooledTransaction>>, CoinbaseTipOrdering<EthPooledTransaction>, S>
test-utils
only.Returns a new Pool
that uses the default TransactionValidationTaskExecutor
when
validating EthPooledTransaction
s and ords via CoinbaseTipOrdering
§Example
use reth_chainspec::MAINNET;
use reth_storage_api::StateProviderFactory;
use reth_tasks::TokioTaskExecutor;
use reth_transaction_pool::{
blobstore::InMemoryBlobStore, Pool, TransactionValidationTaskExecutor,
};
let blob_store = InMemoryBlobStore::default();
let pool = Pool::eth_pool(
TransactionValidationTaskExecutor::eth(
client,
MAINNET.clone(),
blob_store.clone(),
TokioTaskExecutor::default(),
),
blob_store,
Default::default(),
);
Trait Implementations§
§impl<V, T, S> Clone for Pool<V, T, S>where
T: TransactionOrdering,
impl<V, T, S> Clone for Pool<V, T, S>where
T: TransactionOrdering,
§impl From<TestPoolBuilder> for Pool<MockTransactionValidator<MockTransaction>, CoinbaseTipOrdering<MockTransaction>, InMemoryBlobStore>
impl From<TestPoolBuilder> for Pool<MockTransactionValidator<MockTransaction>, CoinbaseTipOrdering<MockTransaction>, InMemoryBlobStore>
§fn from(
wrapper: TestPoolBuilder,
) -> Pool<MockTransactionValidator<MockTransaction>, CoinbaseTipOrdering<MockTransaction>, InMemoryBlobStore>
fn from( wrapper: TestPoolBuilder, ) -> Pool<MockTransactionValidator<MockTransaction>, CoinbaseTipOrdering<MockTransaction>, InMemoryBlobStore>
§impl<V, T, S> TransactionPool for Pool<V, T, S>where
V: TransactionValidator,
<V as TransactionValidator>::Transaction: EthPoolTransaction,
T: TransactionOrdering<Transaction = <V as TransactionValidator>::Transaction>,
S: BlobStore,
impl<V, T, S> TransactionPool for Pool<V, T, S>where
V: TransactionValidator,
<V as TransactionValidator>::Transaction: EthPoolTransaction,
T: TransactionOrdering<Transaction = <V as TransactionValidator>::Transaction>,
S: BlobStore,
implements the TransactionPool
interface for various transaction pool API consumers.
§fn get_pending_transactions_by_origin(
&self,
origin: TransactionOrigin,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_pending_transactions_by_origin( &self, origin: TransactionOrigin, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
Returns all pending transactions filtered by TransactionOrigin
§type Transaction = <T as TransactionOrdering>::Transaction
type Transaction = <T as TransactionOrdering>::Transaction
§fn block_info(&self) -> BlockInfo
fn block_info(&self) -> BlockInfo
§async fn add_transaction_and_subscribe(
&self,
origin: TransactionOrigin,
transaction: <Pool<V, T, S> as TransactionPool>::Transaction,
) -> Result<TransactionEvents, PoolError>
async fn add_transaction_and_subscribe( &self, origin: TransactionOrigin, transaction: <Pool<V, T, S> as TransactionPool>::Transaction, ) -> Result<TransactionEvents, PoolError>
§async fn add_transaction(
&self,
origin: TransactionOrigin,
transaction: <Pool<V, T, S> as TransactionPool>::Transaction,
) -> Result<FixedBytes<32>, PoolError>
async fn add_transaction( &self, origin: TransactionOrigin, transaction: <Pool<V, T, S> as TransactionPool>::Transaction, ) -> Result<FixedBytes<32>, PoolError>
§async fn add_transactions(
&self,
origin: TransactionOrigin,
transactions: Vec<<Pool<V, T, S> as TransactionPool>::Transaction>,
) -> Vec<Result<FixedBytes<32>, PoolError>>
async fn add_transactions( &self, origin: TransactionOrigin, transactions: Vec<<Pool<V, T, S> as TransactionPool>::Transaction>, ) -> Vec<Result<FixedBytes<32>, PoolError>>
§fn transaction_event_listener(
&self,
tx_hash: FixedBytes<32>,
) -> Option<TransactionEvents>
fn transaction_event_listener( &self, tx_hash: FixedBytes<32>, ) -> Option<TransactionEvents>
§fn all_transactions_event_listener(
&self,
) -> AllTransactionsEvents<<Pool<V, T, S> as TransactionPool>::Transaction>
fn all_transactions_event_listener( &self, ) -> AllTransactionsEvents<<Pool<V, T, S> as TransactionPool>::Transaction>
§fn pending_transactions_listener_for(
&self,
kind: TransactionListenerKind,
) -> Receiver<FixedBytes<32>>
fn pending_transactions_listener_for( &self, kind: TransactionListenerKind, ) -> Receiver<FixedBytes<32>>
§fn blob_transaction_sidecars_listener(&self) -> Receiver<NewBlobSidecar>
fn blob_transaction_sidecars_listener(&self) -> Receiver<NewBlobSidecar>
§fn new_transactions_listener_for(
&self,
kind: TransactionListenerKind,
) -> Receiver<NewTransactionEvent<<Pool<V, T, S> as TransactionPool>::Transaction>>
fn new_transactions_listener_for( &self, kind: TransactionListenerKind, ) -> Receiver<NewTransactionEvent<<Pool<V, T, S> as TransactionPool>::Transaction>>
§fn pooled_transaction_hashes(&self) -> Vec<FixedBytes<32>>
fn pooled_transaction_hashes(&self) -> Vec<FixedBytes<32>>
§fn pooled_transaction_hashes_max(&self, max: usize) -> Vec<FixedBytes<32>>
fn pooled_transaction_hashes_max(&self, max: usize) -> Vec<FixedBytes<32>>
max
hashes of transactions in the pool. Read more§fn pooled_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn pooled_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn pooled_transactions_max(
&self,
max: usize,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn pooled_transactions_max( &self, max: usize, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
max
transactions in the pool. Read more§fn get_pooled_transaction_elements(
&self,
tx_hashes: Vec<FixedBytes<32>>,
limit: GetPooledTransactionLimit,
) -> Vec<PooledTransactionsElement>
fn get_pooled_transaction_elements( &self, tx_hashes: Vec<FixedBytes<32>>, limit: GetPooledTransactionLimit, ) -> Vec<PooledTransactionsElement>
§fn get_pooled_transaction_element(
&self,
tx_hash: FixedBytes<32>,
) -> Option<PooledTransactionsElement>
fn get_pooled_transaction_element( &self, tx_hash: FixedBytes<32>, ) -> Option<PooledTransactionsElement>
§fn best_transactions(
&self,
) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>>
fn best_transactions( &self, ) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>>
§fn best_transactions_with_attributes(
&self,
best_transactions_attributes: BestTransactionsAttributes,
) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>>
fn best_transactions_with_attributes( &self, best_transactions_attributes: BestTransactionsAttributes, ) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>>
§fn pending_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn pending_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn queued_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn queued_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn all_transactions(
&self,
) -> AllPoolTransactions<<Pool<V, T, S> as TransactionPool>::Transaction>
fn all_transactions( &self, ) -> AllPoolTransactions<<Pool<V, T, S> as TransactionPool>::Transaction>
§fn remove_transactions(
&self,
hashes: Vec<FixedBytes<32>>,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn remove_transactions( &self, hashes: Vec<FixedBytes<32>>, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn remove_transactions_and_descendants(
&self,
hashes: Vec<FixedBytes<32>>,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn remove_transactions_and_descendants( &self, hashes: Vec<FixedBytes<32>>, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn remove_transactions_by_sender(
&self,
sender: Address,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn remove_transactions_by_sender( &self, sender: Address, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn retain_unknown<A>(&self, announcement: &mut A)where
A: HandleMempoolData,
fn retain_unknown<A>(&self, announcement: &mut A)where
A: HandleMempoolData,
§fn get(
&self,
tx_hash: &FixedBytes<32>,
) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get( &self, tx_hash: &FixedBytes<32>, ) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_all(
&self,
txs: Vec<FixedBytes<32>>,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_all( &self, txs: Vec<FixedBytes<32>>, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn on_propagated(&self, txs: PropagatedTransactions)
fn on_propagated(&self, txs: PropagatedTransactions)
§fn get_transactions_by_sender(
&self,
sender: Address,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_transactions_by_sender( &self, sender: Address, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_pending_transactions_with_predicate(
&self,
predicate: impl FnMut(&ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>) -> bool,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_pending_transactions_with_predicate( &self, predicate: impl FnMut(&ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>) -> bool, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_pending_transactions_by_sender(
&self,
sender: Address,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_pending_transactions_by_sender( &self, sender: Address, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_queued_transactions_by_sender(
&self,
sender: Address,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_queued_transactions_by_sender( &self, sender: Address, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_highest_transaction_by_sender(
&self,
sender: Address,
) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_highest_transaction_by_sender( &self, sender: Address, ) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_highest_consecutive_transaction_by_sender(
&self,
sender: Address,
on_chain_nonce: u64,
) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_highest_consecutive_transaction_by_sender( &self, sender: Address, on_chain_nonce: u64, ) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_transaction_by_sender_and_nonce(
&self,
sender: Address,
nonce: u64,
) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_transaction_by_sender_and_nonce( &self, sender: Address, nonce: u64, ) -> Option<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn get_transactions_by_origin(
&self,
origin: TransactionOrigin,
) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
fn get_transactions_by_origin( &self, origin: TransactionOrigin, ) -> Vec<Arc<ValidPoolTransaction<<Pool<V, T, S> as TransactionPool>::Transaction>>>
§fn unique_senders(&self) -> HashSet<Address>
fn unique_senders(&self) -> HashSet<Address>
§fn get_blob(
&self,
tx_hash: FixedBytes<32>,
) -> Result<Option<Arc<BlobTransactionSidecar>>, BlobStoreError>
fn get_blob( &self, tx_hash: FixedBytes<32>, ) -> Result<Option<Arc<BlobTransactionSidecar>>, BlobStoreError>
§fn get_all_blobs(
&self,
tx_hashes: Vec<FixedBytes<32>>,
) -> Result<Vec<(FixedBytes<32>, Arc<BlobTransactionSidecar>)>, BlobStoreError>
fn get_all_blobs( &self, tx_hashes: Vec<FixedBytes<32>>, ) -> Result<Vec<(FixedBytes<32>, Arc<BlobTransactionSidecar>)>, BlobStoreError>
§fn get_all_blobs_exact(
&self,
tx_hashes: Vec<FixedBytes<32>>,
) -> Result<Vec<Arc<BlobTransactionSidecar>>, BlobStoreError>
fn get_all_blobs_exact( &self, tx_hashes: Vec<FixedBytes<32>>, ) -> Result<Vec<Arc<BlobTransactionSidecar>>, BlobStoreError>
§fn get_blobs_for_versioned_hashes(
&self,
versioned_hashes: &[FixedBytes<32>],
) -> Result<Vec<Option<BlobAndProofV1>>, BlobStoreError>
fn get_blobs_for_versioned_hashes( &self, versioned_hashes: &[FixedBytes<32>], ) -> Result<Vec<Option<BlobAndProofV1>>, BlobStoreError>
BlobTransactionSidecar
s for a list of blob versioned hashes.§fn add_external_transaction(
&self,
transaction: Self::Transaction,
) -> impl Future<Output = Result<FixedBytes<32>, PoolError>> + Send
fn add_external_transaction( &self, transaction: Self::Transaction, ) -> impl Future<Output = Result<FixedBytes<32>, PoolError>> + Send
§fn add_external_transactions(
&self,
transactions: Vec<Self::Transaction>,
) -> impl Future<Output = Vec<Result<FixedBytes<32>, PoolError>>> + Send
fn add_external_transactions( &self, transactions: Vec<Self::Transaction>, ) -> impl Future<Output = Vec<Result<FixedBytes<32>, PoolError>>> + Send
§fn pending_transactions_listener(&self) -> Receiver<FixedBytes<32>>
fn pending_transactions_listener(&self) -> Receiver<FixedBytes<32>>
§fn new_transactions_listener(
&self,
) -> Receiver<NewTransactionEvent<Self::Transaction>>
fn new_transactions_listener( &self, ) -> Receiver<NewTransactionEvent<Self::Transaction>>
§fn new_pending_pool_transactions_listener(
&self,
) -> NewSubpoolTransactionStream<Self::Transaction>
fn new_pending_pool_transactions_listener( &self, ) -> NewSubpoolTransactionStream<Self::Transaction>
§fn new_basefee_pool_transactions_listener(
&self,
) -> NewSubpoolTransactionStream<Self::Transaction>
fn new_basefee_pool_transactions_listener( &self, ) -> NewSubpoolTransactionStream<Self::Transaction>
§fn new_queued_transactions_listener(
&self,
) -> NewSubpoolTransactionStream<Self::Transaction>
fn new_queued_transactions_listener( &self, ) -> NewSubpoolTransactionStream<Self::Transaction>
§fn contains(&self, tx_hash: &FixedBytes<32>) -> bool
fn contains(&self, tx_hash: &FixedBytes<32>) -> bool
§fn get_local_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
fn get_local_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
§fn get_private_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
fn get_private_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
§fn get_external_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
fn get_external_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
§fn get_local_pending_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
fn get_local_pending_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
§fn get_private_pending_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
fn get_private_pending_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
§fn get_external_pending_transactions(
&self,
) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
fn get_external_pending_transactions( &self, ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>
§impl<V, T, S> TransactionPoolExt for Pool<V, T, S>where
V: TransactionValidator,
<V as TransactionValidator>::Transaction: EthPoolTransaction,
T: TransactionOrdering<Transaction = <V as TransactionValidator>::Transaction>,
S: BlobStore,
impl<V, T, S> TransactionPoolExt for Pool<V, T, S>where
V: TransactionValidator,
<V as TransactionValidator>::Transaction: EthPoolTransaction,
T: TransactionOrdering<Transaction = <V as TransactionValidator>::Transaction>,
S: BlobStore,
§fn set_block_info(&self, info: BlockInfo)
fn set_block_info(&self, info: BlockInfo)
§fn on_canonical_state_change(&self, update: CanonicalStateUpdate<'_>)
fn on_canonical_state_change(&self, update: CanonicalStateUpdate<'_>)
§fn update_accounts(&self, accounts: Vec<ChangedAccount>)
fn update_accounts(&self, accounts: Vec<ChangedAccount>)
§fn delete_blob(&self, tx: FixedBytes<32>)
fn delete_blob(&self, tx: FixedBytes<32>)
§fn delete_blobs(&self, txs: Vec<FixedBytes<32>>)
fn delete_blobs(&self, txs: Vec<FixedBytes<32>>)
§fn cleanup_blobs(&self)
fn cleanup_blobs(&self)
Auto Trait Implementations§
impl<V, T, S> Freeze for Pool<V, T, S>
impl<V, T, S> !RefUnwindSafe for Pool<V, T, S>
impl<V, T, S> Send for Pool<V, T, S>
impl<V, T, S> Sync for Pool<V, T, S>
impl<V, T, S> Unpin for Pool<V, T, S>
impl<V, T, S> !UnwindSafe for Pool<V, T, S>
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<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<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 8 bytes