Enum gear_core::tasks::ScheduledTask

pub enum ScheduledTask<RFM, SD, SUM> {
    PauseProgram(ProgramId),
    RemoveCode(CodeId),
    RemoveFromMailbox(RFM, MessageId),
    RemoveFromWaitlist(ProgramId, MessageId),
    RemovePausedProgram(ProgramId),
    WakeMessage(ProgramId, MessageId),
    SendDispatch(SD),
    SendUserMessage {
        message_id: MessageId,
        to_mailbox: SUM,
    },
    RemoveGasReservation(ProgramId, ReservationId),
    RemoveResumeSession(u32),
}

Scheduled task sense and required data for processing action.

CAUTION: NEVER ALLOW ScheduledTask BE A BIG DATA. To avoid redundant migrations only append new variant(s) to the enum with an explicit corresponding scale codec index.

Variants

PauseProgram(ProgramId)

Pause program as out of rent one.

RemoveCode(CodeId)

Remove code from code storage as out of rent one.

RemoveFromMailbox(RFM, MessageId)

Remove message from mailbox as out of rent one.

RemoveFromWaitlist(ProgramId, MessageId)

Remove message from waitlist as out of rent one.

RemovePausedProgram(ProgramId)

Remove paused program as dead one (issue #1014).

WakeMessage(ProgramId, MessageId)

Delayed wake of the message at concrete block.

SendDispatch(SD)

Delayed message to program sending.

The message itself stored in DispatchStash.

SendUserMessage

Delayed message to user sending.

The message itself stored in DispatchStash.

Fields

message_id: MessageId

What message to send.

to_mailbox: SUM

Should it be inserted into users mailbox.

RemoveGasReservation(ProgramId, ReservationId)

Remove gas reservation.

RemoveResumeSession(u32)

👎Deprecated: Paused program storage was removed in pallet-gear-program

Remove resume program session.

Implementations

impl<RFM, SD, SUM> ScheduledTask<RFM, SD, SUM>

pub fn process_with(self, handler: &mut impl TaskHandler<RFM, SD, SUM>) -> Gas

Processing function of current task with given handler.

Trait Implementations

impl<RFM: Clone, SD: Clone, SUM: Clone> Clone for ScheduledTask<RFM, SD, SUM>

fn clone(&self) -> ScheduledTask<RFM, SD, SUM>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<RFM: Debug, SD: Debug, SUM: Debug> Debug for ScheduledTask<RFM, SD, SUM>

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

Formats the value using the given formatter.

impl<RFM, SD, SUM> Decode for ScheduledTask<RFM, SD, SUM>

where RFM: Decode, SD: Decode, SUM: 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<RFM, SD, SUM> Encode for ScheduledTask<RFM, SD, SUM>

where RFM: Encode, SD: Encode, SUM: 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<RFM, SD, SUM> MaxEncodedLen for ScheduledTask<RFM, SD, SUM>

where RFM: MaxEncodedLen, SD: MaxEncodedLen, SUM: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<RFM: Ord, SD: Ord, SUM: Ord> Ord for ScheduledTask<RFM, SD, SUM>

fn cmp(&self, other: &ScheduledTask<RFM, SD, SUM>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<RFM: PartialEq, SD: PartialEq, SUM: PartialEq> PartialEq for ScheduledTask<RFM, SD, SUM>

fn eq(&self, other: &ScheduledTask<RFM, SD, SUM>) -> 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<RFM: PartialOrd, SD: PartialOrd, SUM: PartialOrd> PartialOrd for ScheduledTask<RFM, SD, SUM>

fn partial_cmp(&self, other: &ScheduledTask<RFM, SD, SUM>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<RFM, SD, SUM> TypeInfo for ScheduledTask<RFM, SD, SUM>

where RFM: TypeInfo + 'static, SD: TypeInfo + 'static, SUM: TypeInfo + 'static,

type Identity = ScheduledTask<RFM, SD, SUM>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<RFM, SD, SUM> EncodeLike for ScheduledTask<RFM, SD, SUM>

where RFM: Encode, SD: Encode, SUM: Encode,

impl<RFM: Eq, SD: Eq, SUM: Eq> Eq for ScheduledTask<RFM, SD, SUM>

impl<RFM, SD, SUM> StructuralPartialEq for ScheduledTask<RFM, SD, SUM>