Struct pallet_scheduler::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn schedule(
    origin: OriginFor<T>,
    when: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::RuntimeCall>
) -> DispatchResult

Anonymously schedule a task.

pub fn cancel(
    origin: OriginFor<T>,
    when: T::BlockNumber,
    index: u32
) -> DispatchResult

Cancel an anonymously scheduled task.

pub fn schedule_named(
    origin: OriginFor<T>,
    id: TaskName,
    when: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::RuntimeCall>
) -> DispatchResult

Schedule a named task.

pub fn cancel_named(origin: OriginFor<T>, id: TaskName) -> DispatchResult

Cancel a named scheduled task.

pub fn schedule_after(
    origin: OriginFor<T>,
    after: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::RuntimeCall>
) -> DispatchResult

Anonymously schedule a task after a delay.

Same as schedule.

pub fn schedule_named_after(
    origin: OriginFor<T>,
    id: TaskName,
    after: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::RuntimeCall>
) -> DispatchResult

Schedule a named task after a delay.

Same as schedule_named.

impl<T: Config<Hash = PreimageHash>> Pallet<T>

pub fn migrate_v1_to_v4() -> Weight

Migrate storage format from V1 to V4.

Returns the weight consumed by this migration.

pub fn migrate_v2_to_v4() -> Weight

Migrate storage format from V2 to V4.

Returns the weight consumed by this migration.

pub fn migrate_v3_to_v4() -> Weight

Migrate storage format from V3 to V4.

Returns the weight consumed by this migration.

Examples found in repository

src/migration.rs (line 168)

		fn on_runtime_upgrade() -> Weight {
			let version = StorageVersion::get::<Pallet<T>>();
			if version != 3 {
				log::warn!(
					target: TARGET,
					"skipping v3 to v4 migration: executed on wrong storage version.\
				Expected version 3, found {:?}",
					version,
				);
				return T::DbWeight::get().reads(1)
			}

			crate::Pallet::<T>::migrate_v3_to_v4()
		}

impl<T: Config> Pallet<T>

pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + Decode>()

Helper to migrate scheduler when the pallet origin type has changed.

Trait Implementations

impl<T: Config<Hash = PreimageHash>> Anon<<T as Config>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<T as Config>::BlockNumber, u32)

An address which can be used for removing a scheduled task.

type Hash = <T as Config>::Hash

A means of expressing a call by the hash of its encoded data.

fn schedule(
    when: DispatchTime<T::BlockNumber>,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    origin: T::PalletsOrigin,
    call: CallOrHashOf<T>
) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel((when, index): Self::Address) -> Result<(), ()>

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also.

fn reschedule(
    address: Self::Address,
    when: DispatchTime<T::BlockNumber>
) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named.

fn next_dispatch_time(
    (when, index): Self::Address
) -> Result<T::BlockNumber, ()>

Return the next dispatch time for a given task.

impl<T: Config> Anon<<T as Config>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<T as Config>::BlockNumber, u32)

An address which can be used for removing a scheduled task.

fn schedule(
    when: DispatchTime<T::BlockNumber>,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    origin: T::PalletsOrigin,
    call: Bounded<<T as Config>::RuntimeCall>
) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel((when, index): Self::Address) -> Result<(), DispatchError>

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also.

fn reschedule(
    address: Self::Address,
    when: DispatchTime<T::BlockNumber>
) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named.

fn next_dispatch_time(
    (when, index): Self::Address
) -> Result<T::BlockNumber, DispatchError>

Return the next dispatch time for a given task.

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<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> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(now: T::BlockNumber) -> Weight

Execute the scheduled calls

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config<Hash = PreimageHash>> Named<<T as Config>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<T as Config>::BlockNumber, u32)

An address which can be used for removing a scheduled task.

type Hash = <T as Config>::Hash

A means of expressing a call by the hash of its encoded data.

fn schedule_named(
    id: Vec<u8>,
    when: DispatchTime<T::BlockNumber>,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    origin: T::PalletsOrigin,
    call: CallOrHashOf<T>
) -> Result<Self::Address, ()>

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel_named(id: Vec<u8>) -> Result<(), ()>

Cancel a scheduled, named task. If periodic, then it will cancel all further instances of that, also.

fn reschedule_named(
    id: Vec<u8>,
    when: DispatchTime<T::BlockNumber>
) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block.

fn next_dispatch_time(id: Vec<u8>) -> Result<T::BlockNumber, ()>

Return the next dispatch time for a given task.

impl<T: Config> Named<<T as Config>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<T as Config>::BlockNumber, u32)

An address which can be used for removing a scheduled task.

fn schedule_named(
    id: TaskName,
    when: DispatchTime<T::BlockNumber>,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    origin: T::PalletsOrigin,
    call: Bounded<<T as Config>::RuntimeCall>
) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel_named(id: TaskName) -> Result<(), DispatchError>

Cancel a scheduled, named task. If periodic, then it will cancel all further instances of that, also.

fn reschedule_named(
    id: TaskName,
    when: DispatchTime<T::BlockNumber>
) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block.

fn next_dispatch_time(id: TaskName) -> Result<T::BlockNumber, DispatchError>

Return the next dispatch time for a given task.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

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

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>