pub struct NullStateCatchup {
backoff: BackoffParams,
chain_configs: HashMap<Commitment<ChainConfig>, ChainConfig>,
}Expand description
Disable catchup entirely.
Fields§
§backoff: BackoffParams§chain_configs: HashMap<Commitment<ChainConfig>, ChainConfig>Implementations§
Source§impl NullStateCatchup
impl NullStateCatchup
Sourcepub fn add_chain_config(&mut self, cf: ChainConfig)
pub fn add_chain_config(&mut self, cf: ChainConfig)
Add a chain config preimage which can be fetched by hash during STF evaluation.
NullStateCatchup is used to disable catchup entirely when evaluating the STF, which
requires the ValidatedState to be pre-seeded with all
the dependencies of STF evaluation. However, the STF also depends on having the preimage of
various ChainConfig commitments, which are not stored in the
ValidatedState, but which instead must be supplied by a
separate preimage oracle. Thus, NullStateCatchup may be populated with a set of
ChainConfigs, which it can feed to the STF during evaluation.
Trait Implementations§
Source§impl Clone for NullStateCatchup
impl Clone for NullStateCatchup
Source§fn clone(&self) -> NullStateCatchup
fn clone(&self) -> NullStateCatchup
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for NullStateCatchup
impl Debug for NullStateCatchup
Source§impl Default for NullStateCatchup
impl Default for NullStateCatchup
Source§impl StateCatchup for NullStateCatchup
impl StateCatchup for NullStateCatchup
Source§fn try_fetch_leaf<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
_height: u64,
_stake_table: HSStakeTable<SeqTypes>,
_success_threshold: U256,
) -> Pin<Box<dyn Future<Output = Result<Leaf2>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn try_fetch_leaf<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
_height: u64,
_stake_table: HSStakeTable<SeqTypes>,
_success_threshold: U256,
) -> Pin<Box<dyn Future<Output = Result<Leaf2>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn try_fetch_accounts<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_retry: usize,
_instance: &'life1 NodeState,
_height: u64,
_view: ViewNumber,
_fee_merkle_tree_root: FeeMerkleCommitment,
_account: &'life2 [FeeAccount],
) -> Pin<Box<dyn Future<Output = Result<Vec<FeeAccountProof>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn try_fetch_accounts<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_retry: usize,
_instance: &'life1 NodeState,
_height: u64,
_view: ViewNumber,
_fee_merkle_tree_root: FeeMerkleCommitment,
_account: &'life2 [FeeAccount],
) -> Pin<Box<dyn Future<Output = Result<Vec<FeeAccountProof>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Source§fn try_remember_blocks_merkle_tree<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_retry: usize,
_instance: &'life1 NodeState,
_height: u64,
_view: ViewNumber,
_mt: &'life2 mut BlockMerkleTree,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn try_remember_blocks_merkle_tree<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_retry: usize,
_instance: &'life1 NodeState,
_height: u64,
_view: ViewNumber,
_mt: &'life2 mut BlockMerkleTree,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Source§fn try_fetch_chain_config<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
commitment: Commitment<ChainConfig>,
) -> Pin<Box<dyn Future<Output = Result<ChainConfig>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn try_fetch_chain_config<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
commitment: Commitment<ChainConfig>,
) -> Pin<Box<dyn Future<Output = Result<ChainConfig>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn try_fetch_reward_merkle_tree_v2<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
_height: u64,
_view: ViewNumber,
_reward_merkle_tree_root: RewardMerkleCommitmentV2,
_accounts: Arc<Vec<RewardAccountV2>>,
) -> Pin<Box<dyn Future<Output = Result<PermittedRewardMerkleTreeV2>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn try_fetch_reward_merkle_tree_v2<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
_height: u64,
_view: ViewNumber,
_reward_merkle_tree_root: RewardMerkleCommitmentV2,
_accounts: Arc<Vec<RewardAccountV2>>,
) -> Pin<Box<dyn Future<Output = Result<PermittedRewardMerkleTreeV2>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn try_fetch_reward_accounts_v1<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_retry: usize,
_instance: &'life1 NodeState,
_height: u64,
_view: ViewNumber,
_fee_merkle_tree_root: RewardMerkleCommitmentV1,
_account: &'life2 [RewardAccountV1],
) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV1>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn try_fetch_reward_accounts_v1<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_retry: usize,
_instance: &'life1 NodeState,
_height: u64,
_view: ViewNumber,
_fee_merkle_tree_root: RewardMerkleCommitmentV1,
_account: &'life2 [RewardAccountV1],
) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV1>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Source§fn try_fetch_state_cert<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
_epoch: u64,
) -> Pin<Box<dyn Future<Output = Result<LightClientStateUpdateCertificateV2<SeqTypes>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn try_fetch_state_cert<'life0, 'async_trait>(
&'life0 self,
_retry: usize,
_epoch: u64,
) -> Pin<Box<dyn Future<Output = Result<LightClientStateUpdateCertificateV2<SeqTypes>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn backoff(&self) -> &BackoffParams
fn backoff(&self) -> &BackoffParams
Source§fn is_local(&self) -> bool
fn is_local(&self) -> bool
Source§fn fetch_leaf<'life0, 'async_trait>(
&'life0 self,
height: u64,
stake_table: HSStakeTable<SeqTypes>,
success_threshold: Uint<256, 4>,
) -> Pin<Box<dyn Future<Output = Result<Leaf2<SeqTypes>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn fetch_leaf<'life0, 'async_trait>(
&'life0 self,
height: u64,
stake_table: HSStakeTable<SeqTypes>,
success_threshold: Uint<256, 4>,
) -> Pin<Box<dyn Future<Output = Result<Leaf2<SeqTypes>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
Source§fn fetch_accounts<'life0, 'life1, 'async_trait>(
&'life0 self,
instance: &'life1 NodeState,
height: u64,
view: ViewNumber,
fee_merkle_tree_root: <UniversalMerkleTree<FeeAmount, Sha3Digest, FeeAccount, espresso_types::::v0::v0_1::state::FeeMerkleTree::{constant#0}, Sha3Node> as MerkleTreeScheme>::Commitment,
accounts: Vec<FeeAccount>,
) -> Pin<Box<dyn Future<Output = Result<Vec<FeeAccountProof>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn fetch_accounts<'life0, 'life1, 'async_trait>(
&'life0 self,
instance: &'life1 NodeState,
height: u64,
view: ViewNumber,
fee_merkle_tree_root: <UniversalMerkleTree<FeeAmount, Sha3Digest, FeeAccount, espresso_types::::v0::v0_1::state::FeeMerkleTree::{constant#0}, Sha3Node> as MerkleTreeScheme>::Commitment,
accounts: Vec<FeeAccount>,
) -> Pin<Box<dyn Future<Output = Result<Vec<FeeAccountProof>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
Source§fn remember_blocks_merkle_tree<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
instance: &'life1 NodeState,
height: u64,
view: ViewNumber,
mt: &'life2 mut LightWeightMerkleTree<Commitment<Header>, Sha3Digest, u64, 3, Sha3Node>,
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Self: 'async_trait,
fn remember_blocks_merkle_tree<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
instance: &'life1 NodeState,
height: u64,
view: ViewNumber,
mt: &'life2 mut LightWeightMerkleTree<Commitment<Header>, Sha3Digest, u64, 3, Sha3Node>,
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Self: 'async_trait,
Source§fn fetch_chain_config<'life0, 'async_trait>(
&'life0 self,
commitment: Commitment<ChainConfig>,
) -> Pin<Box<dyn Future<Output = Result<ChainConfig, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn fetch_chain_config<'life0, 'async_trait>(
&'life0 self,
commitment: Commitment<ChainConfig>,
) -> Pin<Box<dyn Future<Output = Result<ChainConfig, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn fetch_reward_merkle_tree_v2<'life0, 'async_trait>(
&'life0 self,
height: u64,
view: ViewNumber,
reward_merkle_tree_root: MerkleTreeCommitment<KeccakNode>,
accounts: Arc<Vec<RewardAccountV2>>,
) -> Pin<Box<dyn Future<Output = Result<PermittedRewardMerkleTreeV2, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
Source§fn fetch_reward_accounts_v1<'life0, 'life1, 'async_trait>(
&'life0 self,
instance: &'life1 NodeState,
height: u64,
view: ViewNumber,
reward_merkle_tree_root: <UniversalMerkleTree<RewardAmount, Sha3Digest, RewardAccountV1, espresso_types::::v0::v0_3::state::RewardMerkleTreeV1::{constant#0}, Sha3Node> as MerkleTreeScheme>::Commitment,
accounts: Vec<RewardAccountV1>,
) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV1>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn fetch_reward_accounts_v1<'life0, 'life1, 'async_trait>(
&'life0 self,
instance: &'life1 NodeState,
height: u64,
view: ViewNumber,
reward_merkle_tree_root: <UniversalMerkleTree<RewardAmount, Sha3Digest, RewardAccountV1, espresso_types::::v0::v0_3::state::RewardMerkleTreeV1::{constant#0}, Sha3Node> as MerkleTreeScheme>::Commitment,
accounts: Vec<RewardAccountV1>,
) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV1>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
Source§fn fetch_state_cert<'life0, 'async_trait>(
&'life0 self,
epoch: u64,
) -> Pin<Box<dyn Future<Output = Result<LightClientStateUpdateCertificateV2<SeqTypes>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn fetch_state_cert<'life0, 'async_trait>(
&'life0 self,
epoch: u64,
) -> Pin<Box<dyn Future<Output = Result<LightClientStateUpdateCertificateV2<SeqTypes>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
Auto Trait Implementations§
impl Freeze for NullStateCatchup
impl RefUnwindSafe for NullStateCatchup
impl Send for NullStateCatchup
impl Sync for NullStateCatchup
impl Unpin for NullStateCatchup
impl UnwindSafe for NullStateCatchup
Blanket Implementations§
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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<F, W, T, D> Deserialize<With<T, W>, D> for F
impl<F, W, T, D> Deserialize<With<T, W>, D> for F
§fn deserialize(
&self,
deserializer: &mut D,
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSync for T
impl<T> DowncastSync 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>
§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> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
§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.