Enum hotshot_task_impls::events::HotShotEvent
source · pub enum HotShotEvent<TYPES: NodeType> {
Show 58 variants
Shutdown,
QuorumProposalRecv(Proposal<TYPES, QuorumProposal<TYPES>>, TYPES::SignatureKey),
QuorumVoteRecv(QuorumVote<TYPES>),
TimeoutVoteRecv(TimeoutVote<TYPES>),
TimeoutVoteSend(TimeoutVote<TYPES>),
DaProposalRecv(Proposal<TYPES, DaProposal<TYPES>>, TYPES::SignatureKey),
DaProposalValidated(Proposal<TYPES, DaProposal<TYPES>>, TYPES::SignatureKey),
DaVoteRecv(DaVote<TYPES>),
DaCertificateRecv(DaCertificate<TYPES>),
DaCertificateValidated(DaCertificate<TYPES>),
QuorumProposalSend(Proposal<TYPES, QuorumProposal<TYPES>>, TYPES::SignatureKey),
QuorumVoteSend(QuorumVote<TYPES>),
QuorumVoteDependenciesValidated(TYPES::Time),
QuorumProposalValidated(QuorumProposal<TYPES>, Leaf<TYPES>),
QuorumProposalRequestSend(ProposalRequestPayload<TYPES>, <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType),
QuorumProposalRequestRecv(ProposalRequestPayload<TYPES>, <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType),
QuorumProposalResponseSend(TYPES::SignatureKey, Proposal<TYPES, QuorumProposal<TYPES>>),
QuorumProposalResponseRecv(Proposal<TYPES, QuorumProposal<TYPES>>),
DaProposalSend(Proposal<TYPES, DaProposal<TYPES>>, TYPES::SignatureKey),
DaVoteSend(DaVote<TYPES>),
QcFormed(Either<QuorumCertificate<TYPES>, TimeoutCertificate<TYPES>>),
DacSend(DaCertificate<TYPES>, TYPES::SignatureKey),
ViewChange(TYPES::Time),
ViewSyncTimeout(TYPES::Time, u64, ViewSyncPhase),
ViewSyncPreCommitVoteRecv(ViewSyncPreCommitVote<TYPES>),
ViewSyncCommitVoteRecv(ViewSyncCommitVote<TYPES>),
ViewSyncFinalizeVoteRecv(ViewSyncFinalizeVote<TYPES>),
ViewSyncPreCommitVoteSend(ViewSyncPreCommitVote<TYPES>),
ViewSyncCommitVoteSend(ViewSyncCommitVote<TYPES>),
ViewSyncFinalizeVoteSend(ViewSyncFinalizeVote<TYPES>),
ViewSyncPreCommitCertificate2Recv(ViewSyncPreCommitCertificate2<TYPES>),
ViewSyncCommitCertificate2Recv(ViewSyncCommitCertificate2<TYPES>),
ViewSyncFinalizeCertificate2Recv(ViewSyncFinalizeCertificate2<TYPES>),
ViewSyncPreCommitCertificate2Send(ViewSyncPreCommitCertificate2<TYPES>, TYPES::SignatureKey),
ViewSyncCommitCertificate2Send(ViewSyncCommitCertificate2<TYPES>, TYPES::SignatureKey),
ViewSyncFinalizeCertificate2Send(ViewSyncFinalizeCertificate2<TYPES>, TYPES::SignatureKey),
ViewSyncTrigger(TYPES::Time),
Timeout(TYPES::Time),
TransactionsRecv(Vec<TYPES::Transaction>),
TransactionSend(TYPES::Transaction, TYPES::SignatureKey),
SendPayloadCommitmentAndMetadata(VidCommitment, BuilderCommitment, <TYPES::BlockPayload as BlockPayload<TYPES>>::Metadata, TYPES::Time, Vec1<BuilderFee<TYPES>>, Option<TYPES::AuctionResult>),
BlockRecv(PackedBundle<TYPES>),
BlockReady(VidDisperse<TYPES>, TYPES::Time),
LeafDecided(Vec<Leaf<TYPES>>),
VidDisperseSend(Proposal<TYPES, VidDisperse<TYPES>>, TYPES::SignatureKey),
VidShareRecv(Proposal<TYPES, VidDisperseShare<TYPES>>),
VidShareValidated(Proposal<TYPES, VidDisperseShare<TYPES>>),
UpgradeProposalRecv(Proposal<TYPES, UpgradeProposal<TYPES>>, TYPES::SignatureKey),
UpgradeProposalSend(Proposal<TYPES, UpgradeProposal<TYPES>>, TYPES::SignatureKey),
UpgradeVoteRecv(UpgradeVote<TYPES>),
UpgradeVoteSend(UpgradeVote<TYPES>),
UpgradeCertificateFormed(UpgradeCertificate<TYPES>),
ValidatedStateUpdated(TYPES::Time, View<TYPES>),
LockedViewUpdated(TYPES::Time),
LastDecidedViewUpdated(TYPES::Time),
UpdateHighQc(QuorumCertificate<TYPES>),
HighQcUpdated(QuorumCertificate<TYPES>),
QuorumProposalPreliminarilyValidated(Proposal<TYPES, QuorumProposal<TYPES>>),
}
Expand description
All of the possible events that can be passed between Sequencing HotShot
tasks
Variants§
Shutdown
Shutdown the task
QuorumProposalRecv(Proposal<TYPES, QuorumProposal<TYPES>>, TYPES::SignatureKey)
A quorum proposal has been received from the network; handled by the consensus task
QuorumVoteRecv(QuorumVote<TYPES>)
A quorum vote has been received from the network; handled by the consensus task
TimeoutVoteRecv(TimeoutVote<TYPES>)
A timeout vote received from the network; handled by consensus task
TimeoutVoteSend(TimeoutVote<TYPES>)
Send a timeout vote to the network; emitted by consensus task replicas
DaProposalRecv(Proposal<TYPES, DaProposal<TYPES>>, TYPES::SignatureKey)
A DA proposal has been received from the network; handled by the DA task
DaProposalValidated(Proposal<TYPES, DaProposal<TYPES>>, TYPES::SignatureKey)
A DA proposal has been validated; handled by the DA task and VID task
DaVoteRecv(DaVote<TYPES>)
A DA vote has been received by the network; handled by the DA task
DaCertificateRecv(DaCertificate<TYPES>)
A Data Availability Certificate (DAC) has been received by the network; handled by the consensus task
DaCertificateValidated(DaCertificate<TYPES>)
A DAC is validated.
QuorumProposalSend(Proposal<TYPES, QuorumProposal<TYPES>>, TYPES::SignatureKey)
Send a quorum proposal to the network; emitted by the leader in the consensus task
QuorumVoteSend(QuorumVote<TYPES>)
Send a quorum vote to the next leader; emitted by a replica in the consensus task after seeing a valid quorum proposal
QuorumVoteDependenciesValidated(TYPES::Time)
All dependencies for the quorum vote are validated.
QuorumProposalValidated(QuorumProposal<TYPES>, Leaf<TYPES>)
A quorum proposal with the given parent leaf is validated. The full validation checks include:
- The proposal is not for an old view
- The proposal has been correctly signed by the leader of the current view
- The justify QC is valid
- The proposal passes either liveness or safety check.
QuorumProposalRequestSend(ProposalRequestPayload<TYPES>, <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType)
A quorum proposal is missing for a view that we need.
QuorumProposalRequestRecv(ProposalRequestPayload<TYPES>, <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType)
A quorum proposal was requested by a node for a view.
QuorumProposalResponseSend(TYPES::SignatureKey, Proposal<TYPES, QuorumProposal<TYPES>>)
A quorum proposal was missing for a view. As the leader, we send a reply to the recipient with their key.
QuorumProposalResponseRecv(Proposal<TYPES, QuorumProposal<TYPES>>)
A quorum proposal was requested by a node for a view.
DaProposalSend(Proposal<TYPES, DaProposal<TYPES>>, TYPES::SignatureKey)
Send a DA proposal to the DA committee; emitted by the DA leader (which is the same node as the leader of view v + 1) in the DA task
DaVoteSend(DaVote<TYPES>)
Send a DA vote to the DA leader; emitted by DA committee members in the DA task after seeing a valid DA proposal
QcFormed(Either<QuorumCertificate<TYPES>, TimeoutCertificate<TYPES>>)
The next leader has collected enough votes to form a QC; emitted by the next leader in the consensus task; an internal event only
DacSend(DaCertificate<TYPES>, TYPES::SignatureKey)
The DA leader has collected enough votes to form a DAC; emitted by the DA leader in the DA task; sent to the entire network via the networking task
ViewChange(TYPES::Time)
The current view has changed; emitted by the replica in the consensus task or replica in the view sync task; received by almost all other tasks
ViewSyncTimeout(TYPES::Time, u64, ViewSyncPhase)
Timeout for the view sync protocol; emitted by a replica in the view sync task
ViewSyncPreCommitVoteRecv(ViewSyncPreCommitVote<TYPES>)
Receive a ViewSyncPreCommitVote
from the network; received by a relay in the view sync task
ViewSyncCommitVoteRecv(ViewSyncCommitVote<TYPES>)
Receive a ViewSyncCommitVote
from the network; received by a relay in the view sync task
ViewSyncFinalizeVoteRecv(ViewSyncFinalizeVote<TYPES>)
Receive a ViewSyncFinalizeVote
from the network; received by a relay in the view sync task
ViewSyncPreCommitVoteSend(ViewSyncPreCommitVote<TYPES>)
Send a ViewSyncPreCommitVote
from the network; emitted by a replica in the view sync task
ViewSyncCommitVoteSend(ViewSyncCommitVote<TYPES>)
Send a ViewSyncCommitVote
from the network; emitted by a replica in the view sync task
ViewSyncFinalizeVoteSend(ViewSyncFinalizeVote<TYPES>)
Send a ViewSyncFinalizeVote
from the network; emitted by a replica in the view sync task
ViewSyncPreCommitCertificate2Recv(ViewSyncPreCommitCertificate2<TYPES>)
Receive a ViewSyncPreCommitCertificate2
from the network; received by a replica in the view sync task
ViewSyncCommitCertificate2Recv(ViewSyncCommitCertificate2<TYPES>)
Receive a ViewSyncCommitCertificate2
from the network; received by a replica in the view sync task
ViewSyncFinalizeCertificate2Recv(ViewSyncFinalizeCertificate2<TYPES>)
Receive a ViewSyncFinalizeCertificate2
from the network; received by a replica in the view sync task
ViewSyncPreCommitCertificate2Send(ViewSyncPreCommitCertificate2<TYPES>, TYPES::SignatureKey)
Send a ViewSyncPreCommitCertificate2
from the network; emitted by a relay in the view sync task
ViewSyncCommitCertificate2Send(ViewSyncCommitCertificate2<TYPES>, TYPES::SignatureKey)
Send a ViewSyncCommitCertificate2
from the network; emitted by a relay in the view sync task
ViewSyncFinalizeCertificate2Send(ViewSyncFinalizeCertificate2<TYPES>, TYPES::SignatureKey)
Send a ViewSyncFinalizeCertificate2
from the network; emitted by a relay in the view sync task
ViewSyncTrigger(TYPES::Time)
Trigger the start of the view sync protocol; emitted by view sync task; internal trigger only
Timeout(TYPES::Time)
A consensus view has timed out; emitted by a replica in the consensus task; received by the view sync task; internal event only
TransactionsRecv(Vec<TYPES::Transaction>)
Receive transactions from the network
TransactionSend(TYPES::Transaction, TYPES::SignatureKey)
Send transactions to the network
SendPayloadCommitmentAndMetadata(VidCommitment, BuilderCommitment, <TYPES::BlockPayload as BlockPayload<TYPES>>::Metadata, TYPES::Time, Vec1<BuilderFee<TYPES>>, Option<TYPES::AuctionResult>)
Event to send block payload commitment and metadata from DA leader to the quorum; internal event only
BlockRecv(PackedBundle<TYPES>)
Event when the transactions task has sequenced transactions. Contains the encoded transactions, the metadata, and the view number
BlockReady(VidDisperse<TYPES>, TYPES::Time)
Event when the transactions task has a block formed
LeafDecided(Vec<Leaf<TYPES>>)
Event when consensus decided on a leaf
VidDisperseSend(Proposal<TYPES, VidDisperse<TYPES>>, TYPES::SignatureKey)
Send VID shares to VID storage nodes; emitted by the DA leader
Vid disperse share has been received from the network; handled by the consensus task
VID share data is validated.
UpgradeProposalRecv(Proposal<TYPES, UpgradeProposal<TYPES>>, TYPES::SignatureKey)
Upgrade proposal has been received from the network
UpgradeProposalSend(Proposal<TYPES, UpgradeProposal<TYPES>>, TYPES::SignatureKey)
Upgrade proposal has been sent to the network
UpgradeVoteRecv(UpgradeVote<TYPES>)
Upgrade vote has been received from the network
UpgradeVoteSend(UpgradeVote<TYPES>)
Upgrade vote has been sent to the network
UpgradeCertificateFormed(UpgradeCertificate<TYPES>)
Upgrade certificate has been sent to the network
ValidatedStateUpdated(TYPES::Time, View<TYPES>)
A undecided view has been created and added to the validated state storage.
LockedViewUpdated(TYPES::Time)
A new locked view has been created (2-chain)
LastDecidedViewUpdated(TYPES::Time)
A new anchor view has been successfully reached by this node (3-chain).
UpdateHighQc(QuorumCertificate<TYPES>)
A new high_qc has been reached by this node.
HighQcUpdated(QuorumCertificate<TYPES>)
A new high_qc has been updated in Consensus
.
QuorumProposalPreliminarilyValidated(Proposal<TYPES, QuorumProposal<TYPES>>)
A quorum proposal has been preliminarily validated. The preliminary checks include:
- The proposal is not for an old view
- The proposal has been correctly signed by the leader of the current view
- The justify QC is valid
Implementations§
source§impl<TYPES: NodeType> HotShotEvent<TYPES>
impl<TYPES: NodeType> HotShotEvent<TYPES>
sourcepub fn view_number(&self) -> Option<TYPES::Time>
pub fn view_number(&self) -> Option<TYPES::Time>
Return the view number for a hotshot event if present
Trait Implementations§
source§impl<TYPES: Clone + NodeType> Clone for HotShotEvent<TYPES>where
TYPES::SignatureKey: Clone,
TYPES::Time: Clone,
TYPES::Transaction: Clone,
TYPES::BlockPayload: Clone,
TYPES::AuctionResult: Clone,
impl<TYPES: Clone + NodeType> Clone for HotShotEvent<TYPES>where
TYPES::SignatureKey: Clone,
TYPES::Time: Clone,
TYPES::Transaction: Clone,
TYPES::BlockPayload: Clone,
TYPES::AuctionResult: Clone,
source§fn clone(&self) -> HotShotEvent<TYPES>
fn clone(&self) -> HotShotEvent<TYPES>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<TYPES: Debug + NodeType> Debug for HotShotEvent<TYPES>where
TYPES::SignatureKey: Debug,
TYPES::Time: Debug,
TYPES::Transaction: Debug,
TYPES::BlockPayload: Debug,
TYPES::AuctionResult: Debug,
impl<TYPES: Debug + NodeType> Debug for HotShotEvent<TYPES>where
TYPES::SignatureKey: Debug,
TYPES::Time: Debug,
TYPES::Transaction: Debug,
TYPES::BlockPayload: Debug,
TYPES::AuctionResult: Debug,
source§impl<TYPES: NodeType> Display for HotShotEvent<TYPES>
impl<TYPES: NodeType> Display for HotShotEvent<TYPES>
source§impl<TYPES: PartialEq + NodeType> PartialEq for HotShotEvent<TYPES>where
TYPES::SignatureKey: PartialEq,
TYPES::Time: PartialEq,
TYPES::Transaction: PartialEq,
TYPES::BlockPayload: PartialEq,
TYPES::AuctionResult: PartialEq,
impl<TYPES: PartialEq + NodeType> PartialEq for HotShotEvent<TYPES>where
TYPES::SignatureKey: PartialEq,
TYPES::Time: PartialEq,
TYPES::Transaction: PartialEq,
TYPES::BlockPayload: PartialEq,
TYPES::AuctionResult: PartialEq,
source§fn eq(&self, other: &HotShotEvent<TYPES>) -> bool
fn eq(&self, other: &HotShotEvent<TYPES>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<TYPES: NodeType> TaskEvent for HotShotEvent<TYPES>
impl<TYPES: NodeType> TaskEvent for HotShotEvent<TYPES>
source§fn shutdown_event() -> Self
fn shutdown_event() -> Self
impl<TYPES: Eq + NodeType> Eq for HotShotEvent<TYPES>where
TYPES::SignatureKey: Eq,
TYPES::Time: Eq,
TYPES::Transaction: Eq,
TYPES::BlockPayload: Eq,
TYPES::AuctionResult: Eq,
impl<TYPES: NodeType> StructuralPartialEq for HotShotEvent<TYPES>
Auto Trait Implementations§
impl<TYPES> Freeze for HotShotEvent<TYPES>where
<TYPES as NodeType>::AuctionResult: Freeze,
<TYPES as NodeType>::BlockHeader: Freeze,
<TYPES as NodeType>::BlockPayload: Freeze,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: Freeze,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: Freeze,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: Freeze,
<TYPES as NodeType>::SignatureKey: Freeze,
<TYPES as NodeType>::Time: Freeze,
<TYPES as NodeType>::Transaction: Freeze,
impl<TYPES> RefUnwindSafe for HotShotEvent<TYPES>where
TYPES: RefUnwindSafe,
<TYPES as NodeType>::AuctionResult: RefUnwindSafe,
<TYPES as NodeType>::BlockHeader: RefUnwindSafe,
<TYPES as NodeType>::BlockPayload: RefUnwindSafe,
<<TYPES as NodeType>::BuilderSignatureKey as BuilderSignatureKey>::BuilderSignature: RefUnwindSafe,
<TYPES as NodeType>::BuilderSignatureKey: RefUnwindSafe,
<<TYPES as NodeType>::ValidatedState as ValidatedState<TYPES>>::Delta: RefUnwindSafe,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: RefUnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: RefUnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: RefUnwindSafe,
<TYPES as NodeType>::SignatureKey: RefUnwindSafe,
<TYPES as NodeType>::Time: RefUnwindSafe,
<TYPES as NodeType>::Transaction: RefUnwindSafe,
<TYPES as NodeType>::ValidatedState: RefUnwindSafe,
impl<TYPES> Send for HotShotEvent<TYPES>
impl<TYPES> Sync for HotShotEvent<TYPES>
impl<TYPES> Unpin for HotShotEvent<TYPES>where
TYPES: Unpin,
<TYPES as NodeType>::AuctionResult: Unpin,
<TYPES as NodeType>::BlockHeader: Unpin,
<TYPES as NodeType>::BlockPayload: Unpin,
<<TYPES as NodeType>::BuilderSignatureKey as BuilderSignatureKey>::BuilderSignature: Unpin,
<TYPES as NodeType>::BuilderSignatureKey: Unpin,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: Unpin,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: Unpin,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: Unpin,
<TYPES as NodeType>::SignatureKey: Unpin,
<TYPES as NodeType>::Time: Unpin,
<TYPES as NodeType>::Transaction: Unpin,
impl<TYPES> UnwindSafe for HotShotEvent<TYPES>where
TYPES: UnwindSafe,
<TYPES as NodeType>::AuctionResult: UnwindSafe,
<TYPES as NodeType>::BlockHeader: UnwindSafe,
<TYPES as NodeType>::BlockPayload: UnwindSafe,
<<TYPES as NodeType>::BuilderSignatureKey as BuilderSignatureKey>::BuilderSignature: UnwindSafe,
<TYPES as NodeType>::BuilderSignatureKey: UnwindSafe,
<<TYPES as NodeType>::ValidatedState as ValidatedState<TYPES>>::Delta: RefUnwindSafe,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: UnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: UnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: UnwindSafe,
<TYPES as NodeType>::SignatureKey: UnwindSafe + RefUnwindSafe,
<TYPES as NodeType>::Time: UnwindSafe,
<TYPES as NodeType>::Transaction: UnwindSafe,
<TYPES as NodeType>::ValidatedState: RefUnwindSafe,
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
§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<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
§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<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> 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<D> OwoColorize for D
impl<D> OwoColorize for D
§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
§fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>
fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>
§fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
§fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
§fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
§fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>
fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>
§fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>
fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>
§fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
§fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
§fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
§fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
§fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
§fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
§fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
§fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
§fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
§fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
§fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
§fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
§fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
§fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
§fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
§fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
§fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
§fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
§fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>
fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>
§fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>
fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>
§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read more§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
§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
source§impl<T> SectionExt for T
impl<T> SectionExt for T
§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.