Skip to main content

Consensus

hotshot_new_protocol::consensus

Struct Consensus 

Source 
pub struct Consensus<T: NodeType> {
Show 44 fields
    proposals: BTreeMap<ViewNumber, Proposal<T>>,
    signed_proposals: BTreeMap<ViewNumber, Proposal<T, Proposal<T>>>,
    proposed_views: BTreeSet<ViewNumber>,
    vid_shares: BTreeMap<ViewNumber, VidDisperseShare2<T>>,
    unpaired_proposals: BTreeMap<(ViewNumber, VidCommitment2), (<T as NodeType>::SignatureKey, ProposalMessage<T, Validated>)>,
    unpaired_vid_shares: BTreeMap<(ViewNumber, VidCommitment2), VidDisperseShare2<T>>,
    states_verified: BTreeMap<ViewNumber, Commitment<Leaf2<T>>>,
    blocks_reconstructed: BTreeSet<(ViewNumber, VidCommitment2)>,
    blocks: BTreeMap<(ViewNumber, VidCommitment2), T::BlockPayload>,
    certs: BTreeMap<ViewNumber, Certificate1<T>>,
    certs2: BTreeMap<ViewNumber, Certificate2<T>>,
    timeout_certs: BTreeMap<ViewNumber, TimeoutCertificate2<T>>,
    locked_cert: Option<Certificate1<T>>,
    headers: BTreeMap<(ViewNumber, Commitment<Leaf2<T>>), T::BlockHeader>,
    leaves: BTreeMap<ViewNumber, Leaf2<T>>,
    decided_views: BTreeSet<ViewNumber>,
    decide_floor_view: ViewNumber,
    last_decided_view: ViewNumber,
    last_decided_leaf: Leaf2<T>,
    drb_results: BTreeMap<EpochNumber, DrbResult>,
    voted_1_views: BTreeSet<ViewNumber>,
    voted_2_views: BTreeSet<ViewNumber>,
    stored_proposals: BTreeMap<ViewNumber, Vec<Commitment<Leaf2<T>>>>,
    stored_vids: BTreeSet<ViewNumber>,
    stored_actions: BTreeSet<(ViewNumber, ActionKind)>,
    requested_actions: BTreeSet<(ViewNumber, ActionKind)>,
    stored_high_qc: Option<ViewNumber>,
    pending_vote1: BTreeMap<ViewNumber, Vote1<T>>,
    pending_vote2: BTreeMap<ViewNumber, (Vote2<T>, ViewNumber)>,
    pending_proposal: BTreeMap<ViewNumber, Proposal<T, Proposal<T>>>,
    pre_cutover_views: BTreeSet<ViewNumber>,
    timeout_view: ViewNumber,
    restart_barred_view: ViewNumber,
    current_view: ViewNumber,
    current_epoch: Option<EpochNumber>,
    stake_table_coordinator: EpochMembershipCoordinator<T>,
    public_key: T::SignatureKey,
    private_key: <T::SignatureKey as SignatureKey>::PrivateKey,
    state_private_key: <T::StateSignatureKey as StateSignatureKey>::StatePrivateKey,
    stake_table_capacity: usize,
    state_certs: BTreeMap<EpochNumber, LightClientStateUpdateCertificateV2<T>>,
    node_id: KeyPrefix,
    upgrade_lock: UpgradeLock<T>,
    pub(crate) epoch_height: BlockNumber,

}

Fields§

§proposals: BTreeMap<ViewNumber, Proposal<T>>§signed_proposals: BTreeMap<ViewNumber, Proposal<T, Proposal<T>>>§proposed_views: BTreeSet<ViewNumber>§vid_shares: BTreeMap<ViewNumber, VidDisperseShare2<T>>§unpaired_proposals: BTreeMap<(ViewNumber, VidCommitment2), (<T as NodeType>::SignatureKey, ProposalMessage<T, Validated>)>§unpaired_vid_shares: BTreeMap<(ViewNumber, VidCommitment2), VidDisperseShare2<T>>§states_verified: BTreeMap<ViewNumber, Commitment<Leaf2<T>>>§blocks_reconstructed: BTreeSet<(ViewNumber, VidCommitment2)>§blocks: BTreeMap<(ViewNumber, VidCommitment2), T::BlockPayload>§certs: BTreeMap<ViewNumber, Certificate1<T>>§certs2: BTreeMap<ViewNumber, Certificate2<T>>§timeout_certs: BTreeMap<ViewNumber, TimeoutCertificate2<T>>§locked_cert: Option<Certificate1<T>>§headers: BTreeMap<(ViewNumber, Commitment<Leaf2<T>>), T::BlockHeader>§leaves: BTreeMap<ViewNumber, Leaf2<T>>§decided_views: BTreeSet<ViewNumber>

Views actually emitted in a LeafDecided; once views can decide late, last_decided_view is only a high-water mark.

§decide_floor_view: ViewNumber

Hard lower bound for deciding, pinned to the anchor on restart/cutover: decided_views is not persisted, so a replayed certificate pair could otherwise re-decide pre-anchor views.

§last_decided_view: ViewNumber§last_decided_leaf: Leaf2<T>§drb_results: BTreeMap<EpochNumber, DrbResult>§voted_1_views: BTreeSet<ViewNumber>§voted_2_views: BTreeSet<ViewNumber>§stored_proposals: BTreeMap<ViewNumber, Vec<Commitment<Leaf2<T>>>>

Storage confirmations; sends are gated on these facts.

§stored_vids: BTreeSet<ViewNumber>§stored_actions: BTreeSet<(ViewNumber, ActionKind)>§requested_actions: BTreeSet<(ViewNumber, ActionKind)>§stored_high_qc: Option<ViewNumber>

Highest locked-QC view confirmed persisted; gates release of phase-2 votes.

§pending_vote1: BTreeMap<ViewNumber, Vote1<T>>

Messages constructed and accounted for in voted_*_views / proposed_views, awaiting their storage confirmations. A pending vote2 also records the locked-QC view it must see persisted before release.

§pending_vote2: BTreeMap<ViewNumber, (Vote2<T>, ViewNumber)>§pending_proposal: BTreeMap<ViewNumber, Proposal<T, Proposal<T>>>§pre_cutover_views: BTreeSet<ViewNumber>

Skipped by maybe_vote_2_and_update_lock (V1 AvidM dispersal).

§timeout_view: ViewNumber§restart_barred_view: ViewNumber

Highest view this node may have acted in before a restart (from the persisted action log). Bars re-recording a view’s Vote action, not re-casting the phase-2 vote itself (see Self::vote2_persisted).

§current_view: ViewNumber§current_epoch: Option<EpochNumber>§stake_table_coordinator: EpochMembershipCoordinator<T>§public_key: T::SignatureKey§private_key: <T::SignatureKey as SignatureKey>::PrivateKey§state_private_key: <T::StateSignatureKey as StateSignatureKey>::StatePrivateKey§stake_table_capacity: usize§state_certs: BTreeMap<EpochNumber, LightClientStateUpdateCertificateV2<T>>§node_id: KeyPrefix§upgrade_lock: UpgradeLock<T>§epoch_height: BlockNumber

Implementations§

Source§

impl<T: NodeType> Consensus<T>

Source

pub fn new<B>( membership_coordinator: EpochMembershipCoordinator<T>, public_key: T::SignatureKey, private_key: <T::SignatureKey as SignatureKey>::PrivateKey, state_private_key: <T::StateSignatureKey as StateSignatureKey>::StatePrivateKey, stake_table_capacity: usize, upgrade_lock: UpgradeLock<T>, genesis_leaf: Leaf2<T>, epoch_height: B, ) -> Self
where B: Into<BlockNumber>,

Source

pub fn seed_parent( &mut self, cert1: Certificate1<T>, proposal: Proposal<T>, reconstructed: impl IntoIterator<Item = (ViewNumber, VidCommitment2)>, )

Seed a parent certificate and proposal so the leader of the next view can propose without any external bootstrap injection. Sets the locked certificate and current epoch. After calling this, a subsequent apply that triggers maybe_propose will find the parent cert and proposal it needs.

reconstructed are (view, V2 commitment) pairs to record as already reconstructed blocks. During normal operation this set is populated as VID shares arrive; on restart it starts empty, but the persisted leaf and proposals correspond to blocks this node had already reconstructed in the previous process. Seeding them lets a restarted leader satisfy the parent_block_reconstructed check for its first proposal/vote instead of stalling.

Source

pub fn seed_proposals( &mut self, proposals: impl IntoIterator<Item = Proposal<T>>, )

Seed proposals loaded from storage on restart so the decide chain-walk can follow justify_qc back through views the node had already seen, and so maybe_vote_1/maybe_propose can find the parent of the first post-restart proposal (otherwise never re-fetched).

Source

pub fn seed_locked_cert(&mut self, cert1: Certificate1<T>)

Restore the locked QC persisted on a prior run. Called after seed_parent: the persisted lock can be newer than the decided-anchor QC, and restoring it keeps the node from voting against a block it had already locked. The loaded value is persisted, so it also advances the persistence watermark.

Source

fn bump_stored_high_qc(&mut self, view: ViewNumber)

Advance the locked-QC persistence watermark to view if it is newer.

Source

fn high_qc_persisted(&self, required: ViewNumber) -> bool

Whether the locked QC at required view is persisted.

Source

fn parent_reconstructed( &self, parent_view: ViewNumber, parent_block_commitment: VidCommitment2, parent_leaf: Commitment<Leaf2<T>>, ) -> bool

Whether the parent block counts as reconstructed for voting: either we hold its payload, or our locked QC certifies exactly this parent leaf. A lock is only ever taken on a reconstructed block, so a lock matching the parent is itself proof of reconstruction — letting a restarted node vote on the first proposal built on its restored lock.

Source

pub fn seed_state_cert( &mut self, state_cert: LightClientStateUpdateCertificateV2<T>, )

Seed a state certificate loaded from storage on restart, so a leader proposing on an epoch-root parent QC right after a restart does not stall on a missing state_cert.

Source

pub fn apply_pre_cutover_seed(&mut self, seed: PreCutoverSeed<T>)

Apply a PreCutoverSeed to bridge legacy state into the new protocol. Performs the four operations the seed describes atomically: anchor the decided view, install the undecided leaves so they can be decided via Cert2, register the legacy high_qc, and advance current_view/timeout_view to the pre-cutover frontier.

Idempotent: calling with the same seed twice (or with an older seed) does not regress decided/locked state.

Source

pub(crate) fn register_legacy_qc(&mut self, justify_qc: &Certificate1<T>)

Register justify_qc as Cert1 for its parent view (idempotent) and bump locked_cert if newer.

Source

pub fn proposal_at(&self, view: ViewNumber) -> Option<&Proposal<T>>

Return the proposal stored at the given view, if any.

Source

pub fn cert1_at(&self, view: ViewNumber) -> Option<&Certificate1<T>>

Return the Certificate1 (QC) stored at the given view, if any.

Source

pub fn catchup_evidence(&self) -> Option<CatchupEvidence<T>>

The highest certificate we hold: the locked QC or the latest timeout certificate, whichever has the higher view (ties go to the timeout certificate).

Source

fn signed_vid_share( &self, view: ViewNumber, ) -> Option<SignedProposal<T, VidDisperseShare2<T>>>

Source

pub fn signed_proposal_fetch_request( &self, view: ViewNumber, ) -> Result<ProposalFetchRequest<T>, <T::SignatureKey as SignatureKey>::SignError>

Source

pub fn cert2_at(&self, view: ViewNumber) -> Option<&Certificate2<T>>

Return the Certificate2 stored at the given view, if any.

Source

pub fn timeout_cert_at( &self, view: ViewNumber, ) -> Option<&TimeoutCertificate2<T>>

Return the TimeoutCertificate2 that advanced consensus to view, if any. Keyed by the view it advanced into (i.e. one greater than the view it certified as timed out).

Source

pub fn locked_view(&self) -> Option<ViewNumber>

Return the view of the locked certificate, if set.

Source

pub(crate) fn decide_floor(&self) -> ViewNumber

Newest view that can no longer be decided (and below which decide inputs are dropped): slides DECIDE_BUFFER behind the watermark, pinned at the restart/cutover anchor.

Source

pub fn apply( &mut self, input: ConsensusInput<T>, outbox: &mut Outbox<ConsensusOutput<T>>, )

Apply consensus to the given input and collect protocol outputs.

Source

pub fn last_decided_view(&self) -> ViewNumber

Source

pub fn last_decided_leaf(&self) -> &Leaf2<T>

Source

pub fn undecided_leaves(&self) -> impl Iterator<Item = &Leaf2<T>>

Source

pub fn current_view(&self) -> ViewNumber

Source

pub fn current_epoch(&self) -> Option<EpochNumber>

Source

pub fn resume_from_restart( &mut self, anchor_view: ViewNumber, restart_view: ViewNumber, last_actioned_view: ViewNumber, )

On restart, bar voting and proposing in every view this node may have acted in by raising timeout_view (vote1, propose) and restart_barred_view (vote-action re-recording), pin the decide floor at the anchor, and place the view cursor just past the high QC. Forward-only: never regresses any view.

Source

pub fn wants_proposal_for_view(&self, view: &ViewNumber) -> bool

Source

pub fn signed_proposal( &self, view: &ViewNumber, ) -> Option<&SignedProposal<T, Proposal<T>>>

Source

pub fn gc(&mut self, scope: GcScope)

Garbage-collect per-view state.

The decide inputs (proposals, certs, certs2, deferred certs, decided_views) survive down to Self::decide_floor so a late Cert2 can still decide a gap view.

Source

fn pair_proposal( &mut self, sender: T::SignatureKey, proposal: ProposalMessage<T, Validated>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Pair a validated proposal with this node’s VID share for the same payload.

The half arriving first is parked, keyed by (view, payload commitment).

Source

fn pair_vid_share( &mut self, vid_share: VidDisperseShare2<T>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Pair this node’s VID share with a validated proposal for the same payload.

The half arriving first is parked, keyed by (view, payload commitment).

Source

fn on_proposal_paired( &mut self, sender: T::SignatureKey, proposal: ProposalMessage<T, Validated>, vid_share: VidDisperseShare2<T>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Source

fn handle_proposal_with_vid_share( &mut self, sender: T::SignatureKey, proposal: ProposalMessage<T, Validated>, vid_share: VidDisperseShare2<T>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Source

fn handle_fetched_proposal( &mut self, message: ProposalMessage<T, Validated>, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn request_parent_proposal_if_missing( &self, proposal: &Proposal<T>, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn handle_certificate1( &mut self, certificate: ValidCert<Certificate1<T>>, ) -> Protocol

Source

fn handle_certificate2( &mut self, certificate: ValidCert<Certificate2<T>>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Source

fn adopt_certified_drb(&mut self, view: ViewNumber)

Adopt the successor-epoch DRB carried by the transition leaf at view, once we hold both its proposal and a QC certifying it. A Cert1 over the leaf is a quorum’s endorsement of its next_drb_result, so a catching-up node can use it without waiting on a separate successor-epoch catchup.

Source

fn handle_advance_view( &mut self, cert1: ValidCert<Certificate1<T>>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Advance our view based on a quorum certificate.

Source

fn handle_timeout( &mut self, view: ViewNumber, epoch: EpochNumber, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Source

fn handle_timeout_certificate( &mut self, certificate: ValidCert<TimeoutCertificate2<T>>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Source

fn handle_epoch_change( &mut self, epoch_change: EpochChangeMessage<T, Validated>, outbox: &mut Outbox<ConsensusOutput<T>>, ) -> Protocol

Source

fn maybe_propose( &mut self, view: ViewNumber, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn maybe_decide( &mut self, view: ViewNumber, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn build_state_vote( &self, proposal: &Proposal<T>, ) -> Result<LightClientStateUpdateVote2<T>>

Build a LightClientStateUpdateVote2 for an epoch-root leaf.

Computes the LightClientState from the header, fetches the next-epoch stake-table commitment, and signs both the LCV2 (pre-upgrade, for backward compatibility with existing relay infrastructure) and LCV3 (current) Schnorr signatures.

Source

fn handle_stored( &mut self, stored: StorageOutput<T>, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn release_vote1( &mut self, view: ViewNumber, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn release_vote2( &mut self, view: ViewNumber, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn vote2_persisted(&self, view: ViewNumber) -> bool

Whether the view’s Vote action and VID share are persisted, gating the phase-2 vote. A restart-barred view persisted both before the crash: its vote is re-cast, but its Vote action is never re-recorded.

Source

fn release_proposal( &mut self, view: ViewNumber, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn is_proposal_stored( &self, view: ViewNumber, commitment: &Commitment<Leaf2<T>>, ) -> bool

Source

fn request_action( &mut self, view: ViewNumber, epoch: Option<EpochNumber>, kind: ActionKind, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn maybe_vote_1( &mut self, view: ViewNumber, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn maybe_vote_2_and_update_lock( &mut self, view: ViewNumber, outbox: &mut Outbox<ConsensusOutput<T>>, )

Source

fn is_safe(&self, proposal: &Proposal<T>) -> Result<(), SafetyError>

Source

fn leader_label(&self, view: ViewNumber, epoch: EpochNumber) -> String

Format the leader’s key prefix for the given view/epoch, or "unknown" when the stake table is not available. Used by timeout logging so a reader can immediately see which validator failed to make progress.

Source

fn is_leader(&self, view: ViewNumber, epoch: EpochNumber) -> bool

Source

fn staked_in_epoch(&self, epoch: EpochNumber) -> bool

Source

fn missing_for_vote1(&self, view: ViewNumber) -> Vec<&'static str>

Used for logging. Returns a list of checks that failed for the given trying to vote1

Source

fn missing_for_propose(&self, view: ViewNumber) -> Vec<&'static str>

Used for logging. Returns a list of checks that failed for the given trying to propose

Auto Trait Implementations§

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<T> Conv for T

§

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

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

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

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> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
§

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> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

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<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.
§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,