Struct RecoveredBlock

pub struct RecoveredBlock<B>
where B: Block,
{ /* private fields */ }
Expand description

A block with senders recovered from the block’s transactions.

This type is a SealedBlock with a list of senders that match the transactions in the block.

§Sealing

This type uses lazy sealing to avoid hashing the header until it is needed:

RecoveredBlock::new_unhashed creates a recovered block without hashing the header. RecoveredBlock::new creates a recovered block with the corresponding block hash.

§Recovery

Sender recovery is fallible and can fail if any of the transactions fail to recover the sender. A SealedBlock can be upgraded to a RecoveredBlock using the RecoveredBlock::try_recover or SealedBlock::try_recover method.

Implementations§

§

impl<B> RecoveredBlock<B>
where B: Block,

pub fn new( block: B, senders: Vec<Address>, hash: FixedBytes<32>, ) -> RecoveredBlock<B>

Creates a new recovered block instance with the given senders as provided and the block hash.

Note: This expects that the given senders match the transactions in the block.

pub fn new_unhashed(block: B, senders: Vec<Address>) -> RecoveredBlock<B>

Creates a new recovered block instance with the given senders as provided.

Note: This expects that the given senders match the transactions in the block.

pub fn senders(&self) -> &[Address]

Returns the recovered senders.

pub fn senders_iter(&self) -> impl Iterator<Item = &Address>

Returns an iterator over the recovered senders.

pub fn into_block(self) -> B

Consumes the type and returns the inner block.

pub const fn sealed_block(&self) -> &SealedBlock<B>

Returns a reference to the sealed block.

pub const fn new_sealed( block: SealedBlock<B>, senders: Vec<Address>, ) -> RecoveredBlock<B>

Creates a new recovered block instance with the given SealedBlock and senders as provided

pub fn try_new( block: B, senders: Vec<Address>, hash: FixedBytes<32>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer to recover the senders.

pub fn try_new_unchecked( block: B, senders: Vec<Address>, hash: FixedBytes<32>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>

A safer variant of Self::new that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

pub fn try_new_unhashed( block: B, senders: Vec<Address>, ) -> Result<RecoveredBlock<B>, RecoveryError>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer to recover the senders.

pub fn try_new_unhashed_unchecked( block: B, senders: Vec<Address>, ) -> Result<RecoveredBlock<B>, RecoveryError>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

pub fn try_recover(block: B) -> Result<RecoveredBlock<B>, RecoveryError>

Recovers the senders from the transactions in the block using SignedTransaction::recover_signer.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_unchecked( block: B, ) -> Result<RecoveredBlock<B>, RecoveryError>

Recovers the senders from the transactions in the block using SignedTransaction::recover_signer_unchecked.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed( block: SealedBlock<B>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>

Recovers the senders from the transactions in the block using SignedTransaction::recover_signer.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed_unchecked( block: SealedBlock<B>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>

Recovers the senders from the transactions in the sealed block using SignedTransaction::recover_signer_unchecked.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed_with_senders( block: SealedBlock<B>, senders: Vec<Address>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed_with_senders_unchecked( block: SealedBlock<B>, senders: Vec<Address>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>

A safer variant of Self::new that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

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

Returns the block hash.

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

Returns a copy of the block hash.

pub fn num_hash(&self) -> NumHash

Return the number hash tuple.

pub fn block_with_parent(&self) -> BlockWithParent

Return a [BlockWithParent] for this header.

pub fn clone_header(&self) -> <B as Block>::Header

Clone the header.

pub fn clone_sealed_header(&self) -> SealedHeader<<B as Block>::Header>

Clones the internal header and returns a SealedHeader sealed with the hash.

pub fn clone_sealed_block(&self) -> SealedBlock<B>

Clones the wrapped block and returns the SealedBlock sealed with the hash.

pub fn into_header(self) -> <B as Block>::Header

Consumes the block and returns the block’s header.

pub fn into_body(self) -> <B as Block>::Body

Consumes the block and returns the block’s body.

pub fn into_sealed_block(self) -> SealedBlock<B>

Consumes the block and returns the SealedBlock and drops the recovered senders.

pub fn split_sealed(self) -> (SealedBlock<B>, Vec<Address>)

Consumes the type and returns its components.

pub fn split(self) -> (B, Vec<Address>)

Consumes the type and returns its components.

pub fn transactions_with_sender( &self, ) -> impl Iterator<Item = (&Address, &<<B as Block>::Body as BlockBody>::Transaction)>

Returns an iterator over all transactions and their sender.

pub fn transactions_recovered( &self, ) -> impl Iterator<Item = Recovered<&<<B as Block>::Body as BlockBody>::Transaction>>

Returns an iterator over Recovered<&Transaction>

pub fn into_transactions_recovered( self, ) -> impl Iterator<Item = Recovered<<<B as Block>::Body as BlockBody>::Transaction>>

Consumes the type and returns an iterator over all Recovered transactions in the block.

pub fn into_transactions( self, ) -> Vec<<<B as Block>::Body as BlockBody>::Transaction>

Consumes the block and returns the transactions of the block.

§

impl<B> RecoveredBlock<B>
where B: Block,

pub fn senders_mut(&mut self) -> &mut Vec<Address>

Available on crate feature test-utils only.

Returns a mutable reference to the recovered senders.

pub fn push_sender(&mut self, sender: Address)

Available on crate feature test-utils only.

Appends the sender to the list of senders.

§

impl<B> RecoveredBlock<B>
where B: TestBlock,

pub fn set_header(&mut self, header: <B as Block>::Header)

Available on crate feature test-utils only.

Updates the block header.

pub fn set_hash(&mut self, hash: FixedBytes<32>)

Available on crate feature test-utils only.

Updates the block hash.

pub fn header_mut(&mut self) -> &mut <B as Block>::Header

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub fn block_mut(&mut self) -> &mut <B as Block>::Body

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub fn set_parent_hash(&mut self, hash: FixedBytes<32>)

Available on crate feature test-utils only.

Updates the parent block hash.

pub fn set_block_number(&mut self, number: u64)

Available on crate feature test-utils only.

Updates the block number.

pub fn set_state_root(&mut self, state_root: FixedBytes<32>)

Available on crate feature test-utils only.

Updates the block state root.

pub fn set_difficulty(&mut self, difficulty: Uint<256, 4>)

Available on crate feature test-utils only.

Updates the block difficulty.

Methods from Deref<Target = SealedBlock<B>>§

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

Returns a reference to the block hash.

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

Returns the block hash.

pub fn clone_block(&self) -> B

Clones the wrapped block.

pub fn header(&self) -> &<B as Block>::Header

Returns reference to block header.

pub fn body(&self) -> &<B as Block>::Body

Returns reference to block body.

pub fn rlp_length(&self) -> usize

Returns the length of the block.

pub fn senders(&self) -> Result<Vec<Address>, RecoveryError>

Recovers all senders from the transactions in the block.

Returns None if any of the transactions fail to recover the sender.

pub fn num_hash(&self) -> NumHash

Return the number hash tuple.

pub fn block_with_parent(&self) -> BlockWithParent

Return a [BlockWithParent] for this header.

pub fn sealed_header(&self) -> &SealedHeader<<B as Block>::Header>

Returns the Sealed header.

pub fn sealed_header_ref(&self) -> SealedHeader<&<B as Block>::Header>

Returns the wrapped SealedHeader<B::Header> as SealedHeader<&B::Header>.

pub fn clone_sealed_header(&self) -> SealedHeader<<B as Block>::Header>

Clones the wrapped header and returns a SealedHeader sealed with the hash.

pub fn blob_versioned_hashes_iter( &self, ) -> impl Iterator<Item = &FixedBytes<32>>

Returns an iterator over all blob versioned hashes from the block body.

pub fn transaction_count(&self) -> usize

Returns the number of transactions in the block.

pub fn ensure_transaction_root_valid( &self, ) -> Result<(), GotExpected<FixedBytes<32>>>

Ensures that the transaction root in the block header is valid.

The transaction root is the Keccak 256-bit hash of the root node of the trie structure populated with each transaction in the transactions list portion of the block.

§Returns

Returns Ok(()) if the calculated transaction root matches the one stored in the header, indicating that the transactions in the block are correctly represented in the trie.

Returns Err(error) if the transaction root validation fails, providing a GotExpected error containing the calculated and expected roots.

pub fn header_mut(&mut self) -> &mut <B as Block>::Header

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub fn set_hash(&mut self, hash: FixedBytes<32>)

Available on crate feature test-utils only.

Updates the block hash.

pub fn body_mut(&mut self) -> &mut <B as Block>::Body

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub fn set_parent_hash(&mut self, hash: FixedBytes<32>)

Available on crate feature test-utils only.

Updates the parent block hash.

pub fn set_block_number(&mut self, number: u64)

Available on crate feature test-utils only.

Updates the block number.

pub fn set_state_root(&mut self, state_root: FixedBytes<32>)

Available on crate feature test-utils only.

Updates the block state root.

pub fn set_difficulty(&mut self, difficulty: Uint<256, 4>)

Available on crate feature test-utils only.

Updates the block difficulty.

Trait Implementations§

§

impl<'a, B> Arbitrary<'a> for RecoveredBlock<B>
where B: Block + Arbitrary<'a>,

Available on crate feature arbitrary only.
§

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

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

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

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

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

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

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

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

impl<B> BlockHeader for RecoveredBlock<B>
where B: Block,

§

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

Retrieves the parent hash of the block
§

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

Retrieves the ommers hash of the block
§

fn beneficiary(&self) -> Address

Retrieves the beneficiary (miner) of the block
§

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

Retrieves the state root hash of the block
§

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

Retrieves the transactions root hash of the block
§

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

Retrieves the receipts root hash of the block
§

fn withdrawals_root(&self) -> Option<FixedBytes<32>>

Retrieves the withdrawals root hash of the block, if available
§

fn logs_bloom(&self) -> Bloom

Retrieves the logs bloom filter of the block
§

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

Retrieves the difficulty of the block
§

fn number(&self) -> u64

Retrieves the block number
§

fn gas_limit(&self) -> u64

Retrieves the gas limit of the block
§

fn gas_used(&self) -> u64

Retrieves the gas used by the block
§

fn timestamp(&self) -> u64

Retrieves the timestamp of the block
§

fn mix_hash(&self) -> Option<FixedBytes<32>>

Retrieves the mix hash of the block, if available
§

fn nonce(&self) -> Option<FixedBytes<8>>

Retrieves the nonce of the block, if avaialble
§

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

Retrieves the base fee per gas of the block, if available
§

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

Retrieves the blob gas used by the block, if available
§

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

Retrieves the excess blob gas of the block, if available
§

fn parent_beacon_block_root(&self) -> Option<FixedBytes<32>>

Retrieves the parent beacon block root of the block, if available
§

fn requests_hash(&self) -> Option<FixedBytes<32>>

Retrieves the requests hash of the block, if available
§

fn extra_data(&self) -> &Bytes

Retrieves the block’s extra data field
§

fn blob_fee(&self, blob_params: BlobParams) -> Option<u128>

Returns the blob fee for this block according to the EIP-4844 spec. Read more
§

fn next_block_excess_blob_gas(&self, blob_params: BlobParams) -> Option<u64>

Calculate excess blob gas for the next block according to the EIP-4844 spec. Read more
§

fn maybe_next_block_excess_blob_gas( &self, blob_params: Option<BlobParams>, ) -> Option<u64>

Convenience function for Self::next_block_excess_blob_gas with an optional [BlobParams] argument. Read more
§

fn next_block_blob_fee(&self, blob_params: BlobParams) -> Option<u128>

Returns the blob fee for the next block according to the EIP-4844 spec. Read more
§

fn maybe_next_block_blob_fee( &self, blob_params: Option<BlobParams>, ) -> Option<u128>

Convenience function for Self::next_block_blob_fee with an optional [BlobParams] argument. Read more
§

fn next_block_base_fee(&self, base_fee_params: BaseFeeParams) -> Option<u64>

Calculate base fee for next block according to the EIP-1559 spec. Read more
§

fn parent_num_hash(&self) -> NumHash

Returns the parent block’s number and hash Read more
§

fn is_empty(&self) -> bool

Checks if the header is considered empty - has no transactions, no ommers or withdrawals
§

fn is_zero_difficulty(&self) -> bool

Checks if the block’s difficulty is set to zero, indicating a Proof-of-Stake header. Read more
§

fn exceeds_allowed_future_timestamp(&self, present_timestamp: u64) -> bool

Checks if the block’s timestamp is in the future based on the present timestamp. Read more
§

fn is_nonce_zero(&self) -> bool

Checks if the nonce exists, and if it exists, if it’s zero. Read more
§

impl<B> Clone for RecoveredBlock<B>
where B: Clone + Block,

§

fn clone(&self) -> RecoveredBlock<B>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<B> Debug for RecoveredBlock<B>
where B: Debug + Block,

§

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

Formats the value using the given formatter. Read more
§

impl<B> Default for RecoveredBlock<B>
where B: Block + Default,

§

fn default() -> RecoveredBlock<B>

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

impl<B> Deref for RecoveredBlock<B>
where B: Block,

§

type Target = SealedBlock<B>

The resulting type after dereferencing.
§

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

Dereferences the value.
§

impl<B> DerefMut for RecoveredBlock<B>
where B: Block,

Available on crate feature test-utils only.
§

fn deref_mut(&mut self) -> &mut <RecoveredBlock<B> as Deref>::Target

Mutably dereferences the value.
§

impl<'de, B> Deserialize<'de> for RecoveredBlock<B>

§

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

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

impl<'de, T> DeserializeAs<'de, RecoveredBlock<T>> for RecoveredBlock<'de, T>
where T: Block + 'static, <T as Block>::Header: SerdeBincodeCompat, <T as Block>::Body: SerdeBincodeCompat,

§

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

Deserialize this value from the given Serde deserializer.
§

impl<'a, T> From<&'a RecoveredBlock<T>> for RecoveredBlock<'a, T>
where T: Block + 'static, <T as Block>::Header: SerdeBincodeCompat, <T as Block>::Body: SerdeBincodeCompat,

§

fn from(value: &'a RecoveredBlock<T>) -> RecoveredBlock<'a, T>

Converts to this type from the input type.
Source§

impl<B> From<OrderedRecoveredBlock<B>> for RecoveredBlock<B>
where B: Block,

Source§

fn from(value: OrderedRecoveredBlock<B>) -> RecoveredBlock<B>

Converts to this type from the input type.
§

impl<'a, T> From<RecoveredBlock<'a, T>> for RecoveredBlock<T>
where T: Block + 'static, <T as Block>::Header: SerdeBincodeCompat, <T as Block>::Body: SerdeBincodeCompat,

§

fn from(value: RecoveredBlock<'a, T>) -> RecoveredBlock<T>

Converts to this type from the input type.
§

impl<B> From<RecoveredBlock<B>> for Sealed<B>
where B: Block,

§

fn from(value: RecoveredBlock<B>) -> Sealed<B>

Converts to this type from the input type.
§

impl<B> InMemorySize for RecoveredBlock<B>
where B: Block,

§

fn size(&self) -> usize

Returns a heuristic for the in-memory size of a struct.
§

impl<B> PartialEq for RecoveredBlock<B>
where B: Block,

§

fn eq(&self, other: &RecoveredBlock<B>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<T> SerdeBincodeCompat for RecoveredBlock<T>
where T: Block + 'static, <T as Block>::Header: SerdeBincodeCompat, <T as Block>::Body: SerdeBincodeCompat,

§

type BincodeRepr<'a> = RecoveredBlock<'a, T>

Serde representation of the type for bincode serialization. Read more
§

fn as_repr(&self) -> <RecoveredBlock<T> as SerdeBincodeCompat>::BincodeRepr<'_>

Convert this type into its bincode representation
§

fn from_repr( repr: <RecoveredBlock<T> as SerdeBincodeCompat>::BincodeRepr<'_>, ) -> RecoveredBlock<T>

Convert from the bincode representation
§

impl<B> Serialize for RecoveredBlock<B>

§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl<T> SerializeAs<RecoveredBlock<T>> for RecoveredBlock<'_, T>
where T: Block + 'static, <T as Block>::Header: SerdeBincodeCompat, <T as Block>::Body: SerdeBincodeCompat,

§

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

Serialize this value into the given Serde serializer.
§

impl<B> Eq for RecoveredBlock<B>
where B: Block,

Auto Trait Implementations§

§

impl<B> !Freeze for RecoveredBlock<B>

§

impl<B> RefUnwindSafe for RecoveredBlock<B>
where <B as Block>::Body: RefUnwindSafe, <B as Block>::Header: RefUnwindSafe,

§

impl<B> Send for RecoveredBlock<B>

§

impl<B> Sync for RecoveredBlock<B>

§

impl<B> Unpin for RecoveredBlock<B>

§

impl<B> UnwindSafe for RecoveredBlock<B>
where <B as Block>::Body: UnwindSafe, <B as Block>::Header: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Paint for T
where T: ?Sized,

§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Primary].

§Example
println!("{}", value.primary());
§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color::Fixed].

§Example
println!("{}", value.fixed(color));
§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color::Rgb].

§Example
println!("{}", value.rgb(r, g, b));
§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Black].

§Example
println!("{}", value.black());
§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Red].

§Example
println!("{}", value.red());
§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Green].

§Example
println!("{}", value.green());
§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Yellow].

§Example
println!("{}", value.yellow());
§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Blue].

§Example
println!("{}", value.blue());
§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Magenta].

§Example
println!("{}", value.magenta());
§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Cyan].

§Example
println!("{}", value.cyan());
§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color::White].

§Example
println!("{}", value.white());
§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightBlack].

§Example
println!("{}", value.bright_black());
§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightRed].

§Example
println!("{}", value.bright_red());
§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightGreen].

§Example
println!("{}", value.bright_green());
§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightYellow].

§Example
println!("{}", value.bright_yellow());
§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightBlue].

§Example
println!("{}", value.bright_blue());
§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightMagenta].

§Example
println!("{}", value.bright_magenta());
§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightCyan].

§Example
println!("{}", value.bright_cyan());
§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightWhite].

§Example
println!("{}", value.bright_white());
§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Primary].

§Example
println!("{}", value.on_primary());
§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color::Fixed].

§Example
println!("{}", value.on_fixed(color));
§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color::Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Black].

§Example
println!("{}", value.on_black());
§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Red].

§Example
println!("{}", value.on_red());
§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Green].

§Example
println!("{}", value.on_green());
§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Yellow].

§Example
println!("{}", value.on_yellow());
§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Blue].

§Example
println!("{}", value.on_blue());
§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Magenta].

§Example
println!("{}", value.on_magenta());
§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Cyan].

§Example
println!("{}", value.on_cyan());
§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color::White].

§Example
println!("{}", value.on_white());
§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightBlack].

§Example
println!("{}", value.on_bright_black());
§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightRed].

§Example
println!("{}", value.on_bright_red());
§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightGreen].

§Example
println!("{}", value.on_bright_green());
§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightBlue].

§Example
println!("{}", value.on_bright_blue());
§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightWhite].

§Example
println!("{}", value.on_bright_white());
§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling [Attribute] value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Bold].

§Example
println!("{}", value.bold());
§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Dim].

§Example
println!("{}", value.dim());
§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Italic].

§Example
println!("{}", value.italic());
§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute::Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute::RapidBlink].

§Example
println!("{}", value.rapid_blink());
§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Invert].

§Example
println!("{}", value.invert());
§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Conceal].

§Example
println!("{}", value.conceal());
§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Strike].

§Example
println!("{}", value.strike());
§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi [Quirk] value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Mask].

§Example
println!("{}", value.mask());
§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Wrap].

§Example
println!("{}", value.wrap());
§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Linger].

§Example
println!("{}", value.linger());
§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk::Clear].

§Example
println!("{}", value.clear());
§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Resetting].

§Example
println!("{}", value.resetting());
§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Bright].

§Example
println!("{}", value.bright());
§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::OnBright].

§Example
println!("{}", value.on_bright());
§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the [Condition] value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more
§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types #44874)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryClone for T
where T: Clone,

§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<A> ArbInterop for A
where A: for<'a> Arbitrary<'a> + 'static + Debug + Clone,

§

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

Source§

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

§

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

§

impl<T> Formattable for T
where T: Deref, <T as Deref>::Target: Formattable,

§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T

§

impl<T> MaybeSerde for T
where T: Serialize + for<'de> Deserialize<'de>,

§

impl<T> MaybeSerdeBincodeCompat for T

§

impl<T> NippyJarHeader for T
where T: Send + Sync + Serialize + for<'b> Deserialize<'b> + Debug + 'static,

§

impl<T> Parsable for T
where T: Deref, <T as Deref>::Target: Parsable,

§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

§

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

§

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

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.