Enum Call

pub enum Call<T: Config> {
    schedule {
        when: BlockNumberFor<T>,
        maybe_periodic: Option<Period<BlockNumberFor<T>>>,
        priority: Priority,
        call: Box<<T as Config>::RuntimeCall>,
    },
    cancel {
        when: BlockNumberFor<T>,
        index: u32,
    },
    schedule_named {
        id: TaskName,
        when: BlockNumberFor<T>,
        maybe_periodic: Option<Period<BlockNumberFor<T>>>,
        priority: Priority,
        call: Box<<T as Config>::RuntimeCall>,
    },
    cancel_named {
        id: TaskName,
    },
    schedule_after {
        after: BlockNumberFor<T>,
        maybe_periodic: Option<Period<BlockNumberFor<T>>>,
        priority: Priority,
        call: Box<<T as Config>::RuntimeCall>,
    },
    schedule_named_after {
        id: TaskName,
        after: BlockNumberFor<T>,
        maybe_periodic: Option<Period<BlockNumberFor<T>>>,
        priority: Priority,
        call: Box<<T as Config>::RuntimeCall>,
    },
    set_retry {
        task: TaskAddress<BlockNumberFor<T>>,
        retries: u8,
        period: BlockNumberFor<T>,
    },
    set_retry_named {
        id: TaskName,
        retries: u8,
        period: BlockNumberFor<T>,
    },
    cancel_retry {
        task: TaskAddress<BlockNumberFor<T>>,
    },
    cancel_retry_named {
        id: TaskName,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

schedule

Anonymously schedule a task.

Fields

when: BlockNumberFor<T>

maybe_periodic: Option<Period<BlockNumberFor<T>>>

priority: Priority

call: Box<<T as Config>::RuntimeCall>

cancel

Cancel a scheduled task (named or anonymous), by providing the block it is scheduled for execution in, as well as the index of the task in that block’s agenda.

In the case of a named task, it will remove it from the lookup table as well.

Fields

when: BlockNumberFor<T>

index: u32

schedule_named

Schedule a named task.

Fields

id: TaskName

when: BlockNumberFor<T>

maybe_periodic: Option<Period<BlockNumberFor<T>>>

priority: Priority

call: Box<<T as Config>::RuntimeCall>

cancel_named

Cancel a named scheduled task.

Fields

id: TaskName

schedule_after

Anonymously schedule a task after a delay.

Fields

after: BlockNumberFor<T>

maybe_periodic: Option<Period<BlockNumberFor<T>>>

priority: Priority

call: Box<<T as Config>::RuntimeCall>

schedule_named_after

Schedule a named task after a delay.

Fields

id: TaskName

after: BlockNumberFor<T>

maybe_periodic: Option<Period<BlockNumberFor<T>>>

priority: Priority

call: Box<<T as Config>::RuntimeCall>

set_retry

Set a retry configuration for a task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task’s configuration, but will have a lower value for remaining than the original total_retries.

This call cannot be used to set a retry configuration for a named task.

Fields

task: TaskAddress<BlockNumberFor<T>>

retries: u8

period: BlockNumberFor<T>

set_retry_named

Set a retry configuration for a named task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task’s configuration, but will have a lower value for remaining than the original total_retries.

This is the only way to set a retry configuration for a named task.

Fields

id: TaskName

retries: u8

period: BlockNumberFor<T>

cancel_retry

Removes the retry configuration of a task.

Fields

task: TaskAddress<BlockNumberFor<T>>

cancel_retry_named

Cancel the retry configuration of a named task.

Fields

id: TaskName

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_schedule( when: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant schedule.

pub fn new_call_variant_cancel(when: BlockNumberFor<T>, index: u32) -> Self

Create a call with the variant cancel.

pub fn new_call_variant_schedule_named( id: TaskName, when: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant schedule_named.

pub fn new_call_variant_cancel_named(id: TaskName) -> Self

Create a call with the variant cancel_named.

pub fn new_call_variant_schedule_after( after: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant schedule_after.

pub fn new_call_variant_schedule_named_after( id: TaskName, after: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant schedule_named_after.

pub fn new_call_variant_set_retry( task: TaskAddress<BlockNumberFor<T>>, retries: u8, period: BlockNumberFor<T>, ) -> Self

Create a call with the variant set_retry.

pub fn new_call_variant_set_retry_named( id: TaskName, retries: u8, period: BlockNumberFor<T>, ) -> Self

Create a call with the variant set_retry_named.

pub fn new_call_variant_cancel_retry( task: TaskAddress<BlockNumberFor<T>>, ) -> Self

Create a call with the variant cancel_retry.

pub fn new_call_variant_cancel_retry_named(id: TaskName) -> Self

Create a call with the variant cancel_retry_named.

Trait Implementations

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

fn authorize( &self, source: TransactionSource, ) -> Option<Result<(ValidTransaction, Weight), TransactionValidityError>>

The authorize function.

fn weight_of_authorize(&self) -> Weight

The weight of the authorization function.

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

Tests for self and other values to be equal, and is used by ==.

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

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, BlockNumberFor<T>: TypeInfo + 'static, Option<Period<BlockNumberFor<T>>>: TypeInfo + 'static, Box<<T as Config>::RuntimeCall>: TypeInfo + 'static, TaskAddress<BlockNumberFor<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> DecodeWithMemTracking for Call<T>

where BlockNumberFor<T>: DecodeWithMemTracking, Option<Period<BlockNumberFor<T>>>: DecodeWithMemTracking, Box<<T as Config>::RuntimeCall>: DecodeWithMemTracking, TaskAddress<BlockNumberFor<T>>: DecodeWithMemTracking,

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

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