Enum pallet_migrations::pallet::Call

pub enum Call<T: Config> {
    force_set_cursor {
        cursor: Option<CursorOf<T>>,
    },
    force_set_active_cursor {
        index: u32,
        inner_cursor: Option<RawCursorOf<T>>,
        started_at: Option<BlockNumberFor<T>>,
    },
    force_onboard_mbms {},
    clear_historic {
        selector: HistoricCleanupSelector<IdentifierOf<T>>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

force_set_cursor

Allows root to set a cursor to forcefully start, stop or forward the migration process.

Should normally not be needed and is only in place as emergency measure. Note that restarting the migration process in this manner will not call the [MigrationStatusHandler::started] hook or emit an UpgradeStarted event.

Fields

cursor: Option<CursorOf<T>>

force_set_active_cursor

Allows root to set an active cursor to forcefully start/forward the migration process.

This is an edge-case version of Self::force_set_cursor that allows to set the started_at value to the next block number. Otherwise this would not be possible, since force_set_cursor takes an absolute block number. Setting started_at to None indicates that the current block number plus one should be used.

Fields

index: u32

inner_cursor: Option<RawCursorOf<T>>

started_at: Option<BlockNumberFor<T>>

force_onboard_mbms

Forces the onboarding of the migrations.

This process happens automatically on a runtime upgrade. It is in place as an emergency measurement. The cursor needs to be None for this to succeed.

clear_historic

Clears the Historic set.

map_cursor must be set to the last value that was returned by the HistoricCleared event. The first time None can be used. limit must be chosen in a way that will result in a sensible weight.

Fields

selector: HistoricCleanupSelector<IdentifierOf<T>>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_force_set_cursor(cursor: Option<CursorOf<T>>) -> Self

Create a call with the variant force_set_cursor.

pub fn new_call_variant_force_set_active_cursor( index: u32, inner_cursor: Option<RawCursorOf<T>>, started_at: Option<BlockNumberFor<T>>, ) -> Self

Create a call with the variant force_set_active_cursor.

pub fn new_call_variant_force_onboard_mbms() -> Self

Create a call with the variant force_onboard_mbms.

pub fn new_call_variant_clear_historic( selector: HistoricCleanupSelector<IdentifierOf<T>>, ) -> Self

Create a call with the variant clear_historic.

Trait Implementations

impl<T: Config> CheckIfFeeless for Call<T>

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

impl<T: Config> Clone for Call<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 Call<T>

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

Formats the value using the given formatter.

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

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

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> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names in the same order as [GetCallIndex].

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq for Call<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 Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, Option<CursorOf<T>>: TypeInfo + 'static, Option<RawCursorOf<T>>: TypeInfo + 'static, Option<BlockNumberFor<T>>: TypeInfo + 'static, HistoricCleanupSelector<IdentifierOf<T>>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin, ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

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

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