Enum sp_finality_grandpa::ConsensusLog

pub enum ConsensusLog<N: Codec> {
    ScheduledChange(ScheduledChange<N>),
    ForcedChange(N, ScheduledChange<N>),
    OnDisabled(AuthorityIndex),
    Pause(N),
    Resume(N),
}

An consensus log item for GRANDPA.

Variants

ScheduledChange(ScheduledChange<N>)

Schedule an authority set change.

The earliest digest of this type in a single block will be respected, provided that there is no ForcedChange digest. If there is, then the ForcedChange will take precedence.

No change should be scheduled if one is already and the delay has not passed completely.

This should be a pure function: i.e. as long as the runtime can interpret the digest type it should return the same result regardless of the current state.

ForcedChange(N, ScheduledChange<N>)

Force an authority set change.

Forced changes are applied after a delay of imported blocks, while pending changes are applied after a delay of finalized blocks.

The earliest digest of this type in a single block will be respected, with others ignored.

No change should be scheduled if one is already and the delay has not passed completely.

This should be a pure function: i.e. as long as the runtime can interpret the digest type it should return the same result regardless of the current state.

OnDisabled(AuthorityIndex)

Note that the authority with given index is disabled until the next change.

Pause(N)

A signal to pause the current authority set after the given delay. After finalizing the block at delay the authorities should stop voting.

Resume(N)

A signal to resume the current authority set after the given delay. After authoring the block at delay the authorities should resume voting.

Implementations

impl<N: Codec> ConsensusLog<N>

pub fn try_into_change(self) -> Option<ScheduledChange<N>>

Try to cast the log entry as a contained signal.

pub fn try_into_forced_change(self) -> Option<(N, ScheduledChange<N>)>

Try to cast the log entry as a contained forced signal.

pub fn try_into_pause(self) -> Option<N>

Try to cast the log entry as a contained pause signal.

pub fn try_into_resume(self) -> Option<N>

Try to cast the log entry as a contained resume signal.

Trait Implementations

impl<N: Clone + Codec> Clone for ConsensusLog<N>

fn clone(&self) -> ConsensusLog<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for ConsensusLog<N>where
    N: Debug + Codec,

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

Formats the value using the given formatter.

impl<N> Decode for ConsensusLog<N>where
    ScheduledChange<N>: Decode,
    N: Decode + Codec,

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<N> Encode for ConsensusLog<N>where
    ScheduledChange<N>: Encode,
    N: Encode + Codec,

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<N: PartialEq + Codec> PartialEq<ConsensusLog<N>> for ConsensusLog<N>

fn eq(&self, other: &ConsensusLog<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> Serialize for ConsensusLog<N>where
    N: Serialize + Codec,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<N> EncodeLike<ConsensusLog<N>> for ConsensusLog<N>where
    ScheduledChange<N>: Encode,
    N: Encode + Codec,

impl<N: Eq + Codec> Eq for ConsensusLog<N>

impl<N: Codec> StructuralEq for ConsensusLog<N>

impl<N: Codec> StructuralPartialEq for ConsensusLog<N>