pub struct Consensus<TYPES: NodeType> {
    validated_state_map: BTreeMap<TYPES::Time, View<TYPES>>,
    vid_shares: VidShares<TYPES>,
    saved_da_certs: HashMap<TYPES::Time, DaCertificate<TYPES>>,
    cur_view: TYPES::Time,
    last_proposals: BTreeMap<TYPES::Time, Proposal<TYPES, QuorumProposal<TYPES>>>,
    last_decided_view: TYPES::Time,
    locked_view: TYPES::Time,
    saved_leaves: CommitmentMap<Leaf<TYPES>>,
    last_actions: HotShotActionViews<TYPES::Time>,
    saved_payloads: BTreeMap<TYPES::Time, Arc<[u8]>>,
    high_qc: QuorumCertificate<TYPES>,
    pub metrics: Arc<ConsensusMetricsValue>,
}
Expand description

A reference to the consensus algorithm

This will contain the state of all rounds.

Fields§

§validated_state_map: BTreeMap<TYPES::Time, View<TYPES>>

The validated states that are currently loaded in memory.

§vid_shares: VidShares<TYPES>

All the VID shares we’ve received for current and future views.

§saved_da_certs: HashMap<TYPES::Time, DaCertificate<TYPES>>

All the DA certs we’ve received for current and future views. view -> DA cert

§cur_view: TYPES::Time

View number that is currently on.

§last_proposals: BTreeMap<TYPES::Time, Proposal<TYPES, QuorumProposal<TYPES>>>

Last proposals we sent out, None if we haven’t proposed yet. Prevents duplicate proposals, and can be served to those trying to catchup

§last_decided_view: TYPES::Time

last view had a successful decide event

§locked_view: TYPES::Time

The locked_qc view number

§saved_leaves: CommitmentMap<Leaf<TYPES>>

Map of leaf hash -> leaf

  • contains undecided leaves
  • includes the MOST RECENT decided leaf
§last_actions: HotShotActionViews<TYPES::Time>

Bundle of views which we performed the most recent action visibible to the network. Actions are votes and proposals for DA and Quorum

§saved_payloads: BTreeMap<TYPES::Time, Arc<[u8]>>

Saved payloads.

Encoded transactions for every view if we got a payload for that view.

§high_qc: QuorumCertificate<TYPES>

the highqc per spec

§metrics: Arc<ConsensusMetricsValue>

A reference to the metrics trait

Implementations§

source§

impl<TYPES: NodeType> Consensus<TYPES>

source

pub fn new( validated_state_map: BTreeMap<TYPES::Time, View<TYPES>>, cur_view: TYPES::Time, locked_view: TYPES::Time, last_decided_view: TYPES::Time, last_actioned_view: TYPES::Time, last_proposals: BTreeMap<TYPES::Time, Proposal<TYPES, QuorumProposal<TYPES>>>, saved_leaves: CommitmentMap<Leaf<TYPES>>, saved_payloads: BTreeMap<TYPES::Time, Arc<[u8]>>, high_qc: QuorumCertificate<TYPES>, metrics: Arc<ConsensusMetricsValue> ) -> Self

Constructor.

source

pub fn cur_view(&self) -> TYPES::Time

Get the current view.

source

pub fn last_decided_view(&self) -> TYPES::Time

Get the last decided view.

source

pub fn locked_view(&self) -> TYPES::Time

Get the locked view.

source

pub fn high_qc(&self) -> &QuorumCertificate<TYPES>

Get the high QC.

source

pub fn validated_state_map(&self) -> &BTreeMap<TYPES::Time, View<TYPES>>

Get the validated state map.

source

pub fn saved_leaves(&self) -> &CommitmentMap<Leaf<TYPES>>

Get the saved leaves.

source

pub fn saved_payloads(&self) -> &BTreeMap<TYPES::Time, Arc<[u8]>>

Get the saved payloads.

source

pub fn vid_shares(&self) -> &VidShares<TYPES>

Get the vid shares.

source

pub fn saved_da_certs(&self) -> &HashMap<TYPES::Time, DaCertificate<TYPES>>

Get the saved DA certs.

source

pub fn last_proposals( &self ) -> &BTreeMap<TYPES::Time, Proposal<TYPES, QuorumProposal<TYPES>>>

Get the map of our recent proposals

source

pub fn update_view(&mut self, view_number: TYPES::Time) -> Result<()>

Update the current view.

§Errors

Can return an error when the new view_number is not higher than the existing view number.

source

pub fn update_action( &mut self, action: HotShotAction, view: TYPES::Time ) -> bool

Update the last actioned view internally for votes and proposals

Returns true if the action is for a newer view than the last action of that type

source

pub fn reset_actions(&mut self)

reset last actions to genesis so we can resend events in tests

source

pub fn update_proposed_view( &mut self, proposal: Proposal<TYPES, QuorumProposal<TYPES>> ) -> Result<()>

Update the last proposal.

§Errors

Can return an error when the new view_number is not higher than the existing proposed view number.

source

pub fn update_last_decided_view( &mut self, view_number: TYPES::Time ) -> Result<()>

Update the last decided view.

§Errors

Can return an error when the new view_number is not higher than the existing decided view number.

source

pub fn update_locked_view(&mut self, view_number: TYPES::Time) -> Result<()>

Update the locked view.

§Errors

Can return an error when the new view_number is not higher than the existing locked view number.

source

pub fn update_validated_state_map( &mut self, view_number: TYPES::Time, view: View<TYPES> ) -> Result<()>

Update the validated state map with a new view_number/view combo.

§Errors

Can return an error when the new view contains less information than the exisiting view with the same view number.

source

pub fn update_saved_leaves(&mut self, leaf: Leaf<TYPES>)

Update the saved leaves with a new leaf.

source

pub fn update_saved_payloads( &mut self, view_number: TYPES::Time, encoded_transaction: Arc<[u8]> ) -> Result<()>

Update the saved payloads with a new encoded transaction.

§Errors

Can return an error when there’s an existing payload corresponding to the same view number.

source

pub fn update_high_qc( &mut self, high_qc: QuorumCertificate<TYPES> ) -> Result<()>

Update the high QC if given a newer one.

§Errors

Can return an error when the provided high_qc is not newer than the existing entry.

source

pub fn update_vid_shares( &mut self, view_number: TYPES::Time, disperse: Proposal<TYPES, VidDisperseShare<TYPES>> )

Add a new entry to the vid_shares map.

source

pub fn update_saved_da_certs( &mut self, view_number: TYPES::Time, cert: DaCertificate<TYPES> )

Add a new entry to the da_certs map.

source

pub fn visit_leaf_ancestors<F>( &self, start_from: TYPES::Time, terminator: Terminator<TYPES::Time>, ok_when_finished: bool, f: F ) -> Result<(), HotShotError<TYPES>>
where F: FnMut(&Leaf<TYPES>, Arc<<TYPES as NodeType>::ValidatedState>, Option<Arc<<<TYPES as NodeType>::ValidatedState as ValidatedState<TYPES>>::Delta>>) -> bool,

gather information from the parent chain of leaves

§Errors

If the leaf or its ancestors are not found in storage

source

pub fn collect_garbage( &mut self, old_anchor_view: TYPES::Time, new_anchor_view: TYPES::Time )

Garbage collects based on state change right now, this removes from both the saved_payloads and validated_state_map fields of Consensus.

§Panics

On inconsistent stored entries

source

pub fn decided_leaf(&self) -> Leaf<TYPES>

Gets the last decided leaf.

§Panics

if the last decided view’s leaf does not exist in the state map or saved leaves, which should never happen.

source

pub fn state( &self, view_number: TYPES::Time ) -> Option<&Arc<TYPES::ValidatedState>>

Gets the validated state with the given view number, if in the state map.

source

pub fn state_and_delta(&self, view_number: TYPES::Time) -> StateAndDelta<TYPES>

Gets the validated state and state delta with the given view number, if in the state map.

source

pub fn decided_state(&self) -> Arc<TYPES::ValidatedState>

Gets the last decided validated state.

§Panics

If the last decided view’s state does not exist in the state map, which should never happen.

source

pub async fn calculate_and_update_vid( consensus: OuterConsensus<TYPES>, view: <TYPES as NodeType>::Time, membership: Arc<TYPES::Membership>, private_key: &<TYPES::SignatureKey as SignatureKey>::PrivateKey ) -> Option<()>

Associated helper function: Takes LockedConsensusState which will be updated; locks it for read and write accordingly. Calculates VidDisperse based on the view, the txns and the membership, and updates vid_shares map with the signed VidDisperseShare proposals. Returned Option indicates whether the update has actually happened or not.

Trait Implementations§

source§

impl<TYPES: Clone + NodeType> Clone for Consensus<TYPES>
where TYPES::Time: Clone,

source§

fn clone(&self) -> Consensus<TYPES>

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

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

Performs copy-assignment from source. Read more
source§

impl<TYPES: NodeType> Debug for Consensus<TYPES>
where BTreeMap<TYPES::Time, View<TYPES>>: Debug, VidShares<TYPES>: Debug, HashMap<TYPES::Time, DaCertificate<TYPES>>: Debug, TYPES::Time: Debug, BTreeMap<TYPES::Time, Proposal<TYPES, QuorumProposal<TYPES>>>: Debug, CommitmentMap<Leaf<TYPES>>: Debug, HotShotActionViews<TYPES::Time>: Debug, BTreeMap<TYPES::Time, Arc<[u8]>>: Debug, QuorumCertificate<TYPES>: Debug,

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<TYPES> Freeze for Consensus<TYPES>
where <<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: Freeze, <TYPES as NodeType>::Time: Freeze,

§

impl<TYPES> !RefUnwindSafe for Consensus<TYPES>

§

impl<TYPES> Send for Consensus<TYPES>

§

impl<TYPES> Sync for Consensus<TYPES>

§

impl<TYPES> Unpin for Consensus<TYPES>
where TYPES: Unpin, <TYPES as NodeType>::BlockHeader: Unpin, <TYPES as NodeType>::BlockPayload: Unpin, <<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: Unpin, <TYPES as NodeType>::Time: Unpin,

§

impl<TYPES> !UnwindSafe for Consensus<TYPES>

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

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

§

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, 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<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black
§

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black
§

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red
§

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red
§

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green
§

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green
§

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow
§

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue
§

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue
§

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta
§

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple
§

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple
§

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan
§

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white
§

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white
§

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default
§

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red
§

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white
§

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold
§

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim
§

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized
§

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized
Make the text blink
Make the text blink (but fast!)
§

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors
§

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text
§

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either 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,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either 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>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
§

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

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

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

Immutable access to a value. Read more
§

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

Mutable access to a value. Read more
§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<T> 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>,

§

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

§

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