Struct SealedBlock
pub struct SealedBlock<B>where
B: Block,{ /* private fields */ }
Expand description
Sealed full block composed of the block’s header and body.
This type uses lazy sealing to avoid hashing the header until it is needed, see also
SealedHeader
.
Implementations§
§impl<B> SealedBlock<B>where
B: Block,
impl<B> SealedBlock<B>where
B: Block,
pub fn seal_slow(block: B) -> SealedBlock<B>
pub fn seal_slow(block: B) -> SealedBlock<B>
Hashes the header and creates a sealed block.
This calculates the header hash. To create a SealedBlock
without calculating the hash
upfront see SealedBlock::new_unhashed
pub fn new_unchecked(block: B, hash: FixedBytes<32>) -> SealedBlock<B>
pub fn new_unchecked(block: B, hash: FixedBytes<32>) -> SealedBlock<B>
Create a new sealed block instance using the block.
Caution: This assumes the given hash is the block’s hash.
pub fn new_unhashed(block: B) -> SealedBlock<B>
pub fn new_unhashed(block: B) -> SealedBlock<B>
Creates a SealedBlock
from the block without the available hash
pub fn seal_parts(
header: <B as Block>::Header,
body: <B as Block>::Body,
) -> SealedBlock<B>
pub fn seal_parts( header: <B as Block>::Header, body: <B as Block>::Body, ) -> SealedBlock<B>
Creates the SealedBlock
from the block’s parts by hashing the header.
This calculates the header hash. To create a SealedBlock
from its parts without
calculating the hash upfront see SealedBlock::from_parts_unhashed
pub fn from_parts_unhashed(
header: <B as Block>::Header,
body: <B as Block>::Body,
) -> SealedBlock<B>
pub fn from_parts_unhashed( header: <B as Block>::Header, body: <B as Block>::Body, ) -> SealedBlock<B>
Creates the SealedBlock
from the block’s parts without calculating the hash upfront.
pub fn from_parts_unchecked(
header: <B as Block>::Header,
body: <B as Block>::Body,
hash: FixedBytes<32>,
) -> SealedBlock<B>
pub fn from_parts_unchecked( header: <B as Block>::Header, body: <B as Block>::Body, hash: FixedBytes<32>, ) -> SealedBlock<B>
Creates the SealedBlock
from the block’s parts.
pub fn from_sealed_parts(
header: SealedHeader<<B as Block>::Header>,
body: <B as Block>::Body,
) -> SealedBlock<B>
pub fn from_sealed_parts( header: SealedHeader<<B as Block>::Header>, body: <B as Block>::Body, ) -> SealedBlock<B>
Creates the SealedBlock
from the SealedHeader
and the body.
pub fn hash_ref(&self) -> &FixedBytes<32>
pub fn hash_ref(&self) -> &FixedBytes<32>
Returns a reference to the block hash.
pub fn hash(&self) -> FixedBytes<32>
pub fn hash(&self) -> FixedBytes<32>
Returns the block hash.
pub fn split(self) -> (B, FixedBytes<32>)
pub fn split(self) -> (B, FixedBytes<32>)
Consumes the type and returns its components.
pub fn into_block(self) -> B
pub fn into_block(self) -> B
Consumes the type and returns the block.
pub fn unseal(self) -> B
pub fn unseal(self) -> B
Consumes the type and returns the block.
pub fn clone_block(&self) -> B
pub fn clone_block(&self) -> B
Clones the wrapped block.
pub const fn with_senders(self, senders: Vec<Address>) -> RecoveredBlock<B>
pub const fn with_senders(self, senders: Vec<Address>) -> RecoveredBlock<B>
Converts this block into a RecoveredBlock
with the given senders
Note: This method assumes the senders are correct and does not validate them.
pub fn try_with_senders(
self,
senders: Vec<Address>,
) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>
pub fn try_with_senders( self, senders: Vec<Address>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>
Converts this block into a RecoveredBlock
with the given senders 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.
Returns an error if any of the transactions fail to recover the sender.
pub fn try_with_senders_unchecked(
self,
senders: Vec<Address>,
) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>
pub fn try_with_senders_unchecked( self, senders: Vec<Address>, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>
Converts this block into a RecoveredBlock
with the given senders 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(
self,
) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>
pub fn try_recover( self, ) -> 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_unchecked(
self,
) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>
pub fn try_recover_unchecked( self, ) -> Result<RecoveredBlock<B>, BlockRecoveryError<SealedBlock<B>>>
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 rlp_length(&self) -> usize
pub fn rlp_length(&self) -> usize
Returns the length of the block.
pub fn senders(&self) -> Result<Vec<Address>, RecoveryError>
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
pub fn num_hash(&self) -> NumHash
Return the number hash tuple.
pub fn block_with_parent(&self) -> BlockWithParent
pub fn block_with_parent(&self) -> BlockWithParent
Return a [BlockWithParent
] for this header.
pub const fn sealed_header(&self) -> &SealedHeader<<B as Block>::Header>
pub const fn sealed_header(&self) -> &SealedHeader<<B as Block>::Header>
Returns the Sealed header.
pub fn sealed_header_ref(&self) -> SealedHeader<&<B as Block>::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>
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 into_sealed_header(self) -> SealedHeader<<B as Block>::Header>
pub fn into_sealed_header(self) -> SealedHeader<<B as Block>::Header>
Consumes the block and returns the sealed header.
pub fn into_header(self) -> <B as Block>::Header
pub fn into_header(self) -> <B as Block>::Header
Consumes the block and returns the header.
pub fn split_header_body(self) -> (<B as Block>::Header, <B as Block>::Body)
pub fn split_header_body(self) -> (<B as Block>::Header, <B as Block>::Body)
Splits the block into body and header into separate components
pub fn split_sealed_header_body(
self,
) -> (SealedHeader<<B as Block>::Header>, <B as Block>::Body)
pub fn split_sealed_header_body( self, ) -> (SealedHeader<<B as Block>::Header>, <B as Block>::Body)
Splits the block into body and header into separate components.
pub fn blob_versioned_hashes_iter(
&self,
) -> impl Iterator<Item = &FixedBytes<32>>
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
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>>>
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.
§impl<B> SealedBlock<B>where
B: TestBlock,
impl<B> SealedBlock<B>where
B: TestBlock,
pub fn header_mut(&mut self) -> &mut <B as Block>::Header
Available on crate feature test-utils
only.
pub fn header_mut(&mut self) -> &mut <B as Block>::Header
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.
pub fn set_hash(&mut self, hash: FixedBytes<32>)
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.
pub fn body_mut(&mut self) -> &mut <B as Block>::Body
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.
pub fn set_parent_hash(&mut self, hash: FixedBytes<32>)
test-utils
only.Updates the parent block hash.
pub fn set_block_number(&mut self, number: u64)
Available on crate feature test-utils
only.
pub fn set_block_number(&mut self, number: u64)
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.
pub fn set_state_root(&mut self, state_root: FixedBytes<32>)
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.
pub fn set_difficulty(&mut self, difficulty: Uint<256, 4>)
test-utils
only.Updates the block difficulty.
Trait Implementations§
§impl<'a, B> Arbitrary<'a> for SealedBlock<B>
Available on crate feature arbitrary
only.
impl<'a, B> Arbitrary<'a> for SealedBlock<B>
arbitrary
only.§fn arbitrary(u: &mut Unstructured<'a>) -> Result<SealedBlock<B>, Error>
fn arbitrary(u: &mut Unstructured<'a>) -> Result<SealedBlock<B>, Error>
Self
from the given unstructured data. Read more§fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
Self
from the entirety of the given
unstructured data. Read more§fn size_hint(depth: usize) -> (usize, Option<usize>)
fn size_hint(depth: usize) -> (usize, Option<usize>)
Unstructured
this type
needs to construct itself. Read more§fn try_size_hint(
depth: usize,
) -> Result<(usize, Option<usize>), MaxRecursionReached>
fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>
Unstructured
this type
needs to construct itself. Read more§impl<B> Clone for SealedBlock<B>
impl<B> Clone for SealedBlock<B>
§fn clone(&self) -> SealedBlock<B>
fn clone(&self) -> SealedBlock<B>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<B> Debug for SealedBlock<B>
impl<B> Debug for SealedBlock<B>
§impl<B> Decodable for SealedBlock<B>where
B: Block,
impl<B> Decodable for SealedBlock<B>where
B: Block,
§fn decode(buf: &mut &[u8]) -> Result<SealedBlock<B>, Error>
fn decode(buf: &mut &[u8]) -> Result<SealedBlock<B>, Error>
buf
must be advanced past
the decoded object.§impl<B> Default for SealedBlock<B>
impl<B> Default for SealedBlock<B>
§fn default() -> SealedBlock<B>
fn default() -> SealedBlock<B>
§impl<B> Deref for SealedBlock<B>where
B: Block,
impl<B> Deref for SealedBlock<B>where
B: Block,
§impl<'de, B> Deserialize<'de> for SealedBlock<B>
impl<'de, B> Deserialize<'de> for SealedBlock<B>
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<SealedBlock<B>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<SealedBlock<B>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl<'de, T> DeserializeAs<'de, SealedBlock<T>> for SealedBlock<'de, T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
impl<'de, T> DeserializeAs<'de, SealedBlock<T>> for SealedBlock<'de, T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
§fn deserialize_as<D>(
deserializer: D,
) -> Result<SealedBlock<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize_as<D>(
deserializer: D,
) -> Result<SealedBlock<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
§impl<B> Encodable for SealedBlock<B>where
B: Block,
impl<B> Encodable for SealedBlock<B>where
B: Block,
§impl<'a, T> From<&'a SealedBlock<T>> for SealedBlock<'a, T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
impl<'a, T> From<&'a SealedBlock<T>> for SealedBlock<'a, T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
§fn from(value: &'a SealedBlock<T>) -> SealedBlock<'a, T>
fn from(value: &'a SealedBlock<T>) -> SealedBlock<'a, T>
§impl<B> From<B> for SealedBlock<B>where
B: Block,
impl<B> From<B> for SealedBlock<B>where
B: Block,
§fn from(block: B) -> SealedBlock<B>
fn from(block: B) -> SealedBlock<B>
§impl<'a, T> From<SealedBlock<'a, T>> for SealedBlock<T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
impl<'a, T> From<SealedBlock<'a, T>> for SealedBlock<T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
§fn from(value: SealedBlock<'a, T>) -> SealedBlock<T>
fn from(value: SealedBlock<'a, T>) -> SealedBlock<T>
§impl<B> InMemorySize for SealedBlock<B>where
B: Block,
impl<B> InMemorySize for SealedBlock<B>where
B: Block,
§impl<B> PartialEq for SealedBlock<B>
impl<B> PartialEq for SealedBlock<B>
§impl<T> SerdeBincodeCompat for SealedBlock<T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
impl<T> SerdeBincodeCompat for SealedBlock<T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
§type BincodeRepr<'a> = SealedBlock<'a, T>
type BincodeRepr<'a> = SealedBlock<'a, T>
§fn as_repr(&self) -> <SealedBlock<T> as SerdeBincodeCompat>::BincodeRepr<'_>
fn as_repr(&self) -> <SealedBlock<T> as SerdeBincodeCompat>::BincodeRepr<'_>
§fn from_repr(
repr: <SealedBlock<T> as SerdeBincodeCompat>::BincodeRepr<'_>,
) -> SealedBlock<T>
fn from_repr( repr: <SealedBlock<T> as SerdeBincodeCompat>::BincodeRepr<'_>, ) -> SealedBlock<T>
§impl<B> Serialize for SealedBlock<B>
impl<B> Serialize for SealedBlock<B>
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
§impl<T> SerializeAs<SealedBlock<T>> for SealedBlock<'_, T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
impl<T> SerializeAs<SealedBlock<T>> for SealedBlock<'_, T>where
T: Block + 'static,
<T as Block>::Header: SerdeBincodeCompat,
<T as Block>::Body: SerdeBincodeCompat,
§fn serialize_as<S>(
source: &SealedBlock<T>,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize_as<S>(
source: &SealedBlock<T>,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
impl<B> Eq for SealedBlock<B>
impl<B> StructuralPartialEq for SealedBlock<B>where
B: Block,
Auto Trait Implementations§
impl<B> !Freeze for SealedBlock<B>
impl<B> RefUnwindSafe for SealedBlock<B>
impl<B> Send for SealedBlock<B>
impl<B> Sync for SealedBlock<B>
impl<B> Unpin for SealedBlock<B>
impl<B> UnwindSafe for SealedBlock<B>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<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<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> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
Source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<A> ArbInterop for A
impl<'de, T> BorrowedRpcObject<'de> for Twhere
T: RpcBorrow<'de> + RpcSend,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> Formattable for T
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
impl<T> MaybeSerde for Twhere
T: Serialize + for<'de> Deserialize<'de>,
impl<T> MaybeSerdeBincodeCompat for Twhere
T: SerdeBincodeCompat,
impl<T> NippyJarHeader for T
impl<T> Parsable for T
impl<'de, T> RpcBorrow<'de> for T
impl<T> RpcObject for Twhere
T: RpcSend + RpcRecv,
impl<T> RpcRecv for T
impl<T> RpcSend for T
Layout§
Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.