Struct hotshot_types :: consensus :: ConsensusWriteLockGuard Copy item path

impl<'a, TYPES: NodeType> ConsensusWriteLockGuard<'a, TYPES>

pub fn new(lock_guard: RwLockWriteGuard<'a, Consensus<TYPES>>) -> Self

Creates a new instance of ConsensusWriteLockGuard with the same name as parent OuterConsensus

Methods from Deref<Target = Consensus<TYPES>>§

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

Get the current view.

pub fn cur_epoch(&self) -> TYPES::Epoch

Get the current epoch.

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

Get the last decided view.

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

Get the locked view.

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

Get the high QC.

pub fn next_epoch_high_qc(&self) -> Option<&NextEpochQuorumCertificate2<TYPES>>

Get the next epoch high QC.

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

Get the validated state map.

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

Get the saved leaves.

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

Get the saved payloads.

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

Get the vid shares.

pub fn saved_da_certs(&self) -> &HashMap<TYPES::View, DaCertificate2<TYPES>>

Get the saved DA certs.

pub fn last_proposals( &self, ) -> &BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposal2<TYPES>>>

Get the map of our recent proposals

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

Update the current view.

§Errors

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

pub fn parent_leaf_info( &self, leaf: &Leaf2<TYPES>, public_key: &TYPES::SignatureKey, ) -> Option<LeafInfo<TYPES>>

Get the parent Leaf Info from a given leaf and our public key. Returns None if we don’t have the data in out state

pub fn update_epoch(&mut self, epoch_number: TYPES::Epoch) -> Result<()>

Update the current epoch.

§Errors

Can return an error when the new epoch_number is not higher than the existing epoch number.

pub fn update_action( &mut self, action: HotShotAction, view: TYPES::View, ) -> 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

pub fn reset_actions(&mut self)

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

pub fn update_proposed_view( &mut self, proposal: Proposal<TYPES, QuorumProposal2<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.

pub fn update_last_decided_view( &mut self, view_number: TYPES::View, ) -> 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.

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

Update the locked view.

§Errors

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

pub fn update_da_view( &mut self, view_number: TYPES::View, epoch: TYPES::Epoch, payload_commitment: VidCommitment, ) -> 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 existing view with the same view number.

pub fn update_leaf( &mut self, leaf: Leaf2<TYPES>, state: Arc<TYPES::ValidatedState>, delta: Option<Arc<<TYPES::ValidatedState as ValidatedState<TYPES>>::Delta>>, ) -> 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 existing view with the same view number.

fn update_validated_state_map( &mut self, view_number: TYPES::View, new_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 existing view with the same view number.

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

Update the saved leaves with a new leaf.

pub fn update_saved_payloads( &mut self, view_number: TYPES::View, 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.

pub fn update_high_qc( &mut self, high_qc: QuorumCertificate2<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.

pub fn update_next_epoch_high_qc( &mut self, high_qc: NextEpochQuorumCertificate2<TYPES>, ) -> Result<()>

Update the next epoch high QC if given a newer one.

§Errors

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

§Panics

It can’t actually panic. If the option is None, we will not call unwrap on it.

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

Add a new entry to the vid_shares map.

pub fn update_saved_da_certs( &mut self, view_number: TYPES::View, cert: DaCertificate2<TYPES>, )

Add a new entry to the da_certs map.

pub fn visit_leaf_ancestors<F>( &self, start_from: TYPES::View, terminator: Terminator<TYPES::View>, ok_when_finished: bool, f: F, ) -> Result<(), HotShotError<TYPES>>
where F: FnMut(&Leaf2<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

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

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

pub fn decided_leaf(&self) -> Leaf2<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.

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

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

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

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

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.

pub fn is_qc_forming_eqc(&self, qc: &QuorumCertificate2<TYPES>) -> bool

Return true if the QC takes part in forming an eQC, i.e. it is one of the 3-chain certificates but not the eQC itself

pub fn is_high_qc_forming_eqc(&self) -> bool

Returns true if our high qc is forming an eQC

pub fn is_leaf_forming_eqc(&self, leaf_commit: LeafCommitment<TYPES>) -> bool

Return true if the given leaf takes part in forming an eQC, i.e. it is one of the 3-chain leaves but not the eQC leaf itself

pub fn is_leaf_extended(&self, leaf_commit: LeafCommitment<TYPES>) -> bool

Returns true if the given leaf can form an extended Quorum Certificate The Extended Quorum Certificate (eQC) is the third Quorum Certificate formed in three consecutive views for the last block in the epoch.

pub fn is_leaf_for_last_block(&self, leaf_commit: LeafCommitment<TYPES>) -> bool

Returns true if a given leaf is for the last block in the epoch

pub fn is_high_qc_for_last_block(&self) -> bool

Returns true if our high QC is for the last block in the epoch

pub fn check_eqc( &self, proposed_leaf: &Leaf2<TYPES>, parent_leaf: &Leaf2<TYPES>, ) -> bool

Returns true if the parent_leaf formed an eQC for the previous epoch to the proposed_leaf

Trait Implementations§

impl<'a, TYPES: NodeType> DerefMut for ConsensusWriteLockGuard<'a, TYPES>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, TYPES: NodeType> Drop for ConsensusWriteLockGuard<'a, TYPES>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<'a, TYPES: NodeType> Deref for ConsensusWriteLockGuard<'a, TYPES>

type Target = Consensus<TYPES>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

impl<'a, TYPES> !UnwindSafe for ConsensusWriteLockGuard<'a, TYPES>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

impl<T> From<T> for T

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

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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> 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: '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: '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: '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: '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> 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(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

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

Mutable access to the BorrowMut 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(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

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

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, 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

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::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

impl<T> ErasedDestructor for T
where T: 'static,