Enum pallet_migrations::pallet::Event

pub enum Event<T: Config> {
    UpgradeStarted {
        migrations: u32,
    },
    UpgradeCompleted,
    UpgradeFailed,
    MigrationSkipped {
        index: u32,
    },
    MigrationAdvanced {
        index: u32,
        took: BlockNumberFor<T>,
    },
    MigrationCompleted {
        index: u32,
        took: BlockNumberFor<T>,
    },
    MigrationFailed {
        index: u32,
        took: BlockNumberFor<T>,
    },
    HistoricCleared {
        next_cursor: Option<Vec<u8>>,
    },
    // some variants omitted
}

The Event enum of this pallet

Variants

UpgradeStarted

A Runtime upgrade started.

Its end is indicated by UpgradeCompleted or UpgradeFailed.

Fields

migrations: u32

The number of migrations that this upgrade contains.

This can be used to design a progress indicator in combination with counting the MigrationCompleted and MigrationSkipped events.

UpgradeCompleted

The current runtime upgrade completed.

This implies that all of its migrations completed successfully as well.

UpgradeFailed

Runtime upgrade failed.

This is very bad and will require governance intervention.

MigrationSkipped

A migration was skipped since it was already executed in the past.

Fields

index: u32

The index of the skipped migration within the Config::Migrations list.

MigrationAdvanced

A migration progressed.

Fields

index: u32

The index of the migration within the Config::Migrations list.

took: BlockNumberFor<T>

The number of blocks that this migration took so far.

MigrationCompleted

A Migration completed.

Fields

index: u32

The index of the migration within the Config::Migrations list.

took: BlockNumberFor<T>

The number of blocks that this migration took so far.

MigrationFailed

A Migration failed.

This implies that the whole upgrade failed and governance intervention is required.

Fields

index: u32

The index of the migration within the Config::Migrations list.

took: BlockNumberFor<T>

The number of blocks that this migration took so far.

HistoricCleared

The set of historical migrations has been cleared.

Fields

next_cursor: Option<Vec<u8>>

Should be passed to clear_historic in a successive call.

Trait Implementations

impl<T: Config> Clone for Event<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Debug for Event<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Event<T>

where BlockNumberFor<T>: Decode,

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

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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<T: Config> Encode for Event<T>

where BlockNumberFor<T>: Encode,

fn size_hint(&self) -> usize

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

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

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where 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<T: Config> From<Event<T>> for ()

fn from(_: Event<T>)

Converts to this type from the input type.

impl<T: Config> PartialEq for Event<T>

fn eq(&self, other: &Self) -> 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<T> TypeInfo for Event<T>

where BlockNumberFor<T>: TypeInfo + 'static, PhantomData<T>: TypeInfo + 'static, T: Config + 'static,

type Identity = Event<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> EncodeLike for Event<T>

where BlockNumberFor<T>: Encode,

impl<T: Config> Eq for Event<T>