Enum pallet_gear::pallet::Event

pub enum Event<T: Config> {
    MessageQueued {
        id: MessageId,
        source: T::AccountId,
        destination: ProgramId,
        entry: MessageEntry,
    },
    UserMessageSent {
        message: UserMessage,
        expiration: Option<BlockNumberFor<T>>,
    },
    UserMessageRead {
        id: MessageId,
        reason: UserMessageReadReason,
    },
    MessagesDispatched {
        total: <<T as Config>::Messenger as Messenger>::Capacity,
        statuses: BTreeMap<MessageId, DispatchStatus>,
        state_changes: BTreeSet<ProgramId>,
    },
    MessageWaited {
        id: MessageId,
        origin: Option<GasNodeId<MessageId, ReservationId>>,
        reason: MessageWaitedReason,
        expiration: BlockNumberFor<T>,
    },
    MessageWoken {
        id: MessageId,
        reason: MessageWokenReason,
    },
    CodeChanged {
        id: CodeId,
        change: CodeChangeKind<BlockNumberFor<T>>,
    },
    ProgramChanged {
        id: ProgramId,
        change: ProgramChangeKind<BlockNumberFor<T>>,
    },
    QueueNotProcessed,
    ProgramResumeSessionStarted {
        session_id: SessionId,
        account_id: T::AccountId,
        program_id: ProgramId,
        session_end_block: BlockNumberFor<T>,
    },
    // some variants omitted
}

The Event enum of this pallet

Variants

MessageQueued

Fields

id: MessageId

Generated id of the message.

source: T::AccountId

Account id of the source of the message.

destination: ProgramId

Program id, who is the message’s destination.

entry: MessageEntry

Entry point for processing of the message. On the sending stage, the processing function of the program is always known.

User sends message to program, which was successfully added to the Gear message queue.

UserMessageSent

Fields

message: UserMessage

Message sent.

expiration: Option<BlockNumberFor<T>>

Block number of expiration from Mailbox.

Equals Some(_) with block number when message will be removed from Mailbox due to some reasons (see #642, #646 and #1010).

Equals None if message wasn’t inserted to Mailbox and appears as only Event.

Somebody sent a message to the user.

UserMessageRead

Fields

id: MessageId

Id of the message read.

reason: UserMessageReadReason

The reason for the reading (removal from Mailbox).

NOTE: See more docs about reasons at gear_common::event.

Message marked as “read” and removes it from Mailbox. This event only affects messages that were already inserted in Mailbox.

MessagesDispatched

Fields

total: <<T as Config>::Messenger as Messenger>::Capacity

Total amount of messages removed from message queue.

statuses: BTreeMap<MessageId, DispatchStatus>

Execution statuses of the messages, which were already known by Event::MessageQueued (sent from user to program).

state_changes: BTreeSet<ProgramId>

Ids of programs, which state changed during queue processing.

The result of processing the messages within the block.

MessageWaited

Fields

id: MessageId

Id of the message waited.

origin: Option<GasNodeId<MessageId, ReservationId>>

Origin message id, which started messaging chain with programs, where currently waited message was created.

Used to identify by the user that this message associated with him and the concrete initial message.

reason: MessageWaitedReason

The reason of the waiting (addition to Waitlist).

NOTE: See more docs about reasons at gear_common::event.

expiration: BlockNumberFor<T>

Block number of expiration from Waitlist.

Equals block number when message will be removed from Waitlist due to some reasons (see #642, #646 and #1010).

Messages execution delayed (waited) and successfully added to gear waitlist.

MessageWoken

Fields

id: MessageId

Id of the message woken.

reason: MessageWokenReason

The reason of the waking (removal from Waitlist).

NOTE: See more docs about reasons at gear_common::event.

Message is ready to continue its execution and was removed from Waitlist.

CodeChanged

Fields

id: CodeId

Id of the code affected.

change: CodeChangeKind<BlockNumberFor<T>>

Change applied on code with current id.

NOTE: See more docs about change kinds at gear_common::event.

Any data related to program codes changed.

ProgramChanged

Fields

id: ProgramId

Id of the program affected.

change: ProgramChangeKind<BlockNumberFor<T>>

Change applied on program with current id.

NOTE: See more docs about change kinds at gear_common::event.

Any data related to programs changed.

QueueNotProcessed

The pseudo-inherent extrinsic that runs queue processing rolled back or not executed.

ProgramResumeSessionStarted

Fields

session_id: SessionId

Id of the session.

account_id: T::AccountId

Owner of the session.

program_id: ProgramId

Id of the program affected.

session_end_block: BlockNumberFor<T>

Block number when the session will be removed if not finished.

Program resume session has been started.

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 T::AccountId: Decode, Option<BlockNumberFor<T>>: Decode, <<T as Config>::Messenger as Messenger>::Capacity: Decode, BlockNumberFor<T>: Decode, CodeChangeKind<BlockNumberFor<T>>: Decode, ProgramChangeKind<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 T::AccountId: Encode, Option<BlockNumberFor<T>>: Encode, <<T as Config>::Messenger as Messenger>::Capacity: Encode, BlockNumberFor<T>: Encode, CodeChangeKind<BlockNumberFor<T>>: Encode, ProgramChangeKind<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 T::AccountId: TypeInfo + 'static, Option<BlockNumberFor<T>>: TypeInfo + 'static, <<T as Config>::Messenger as Messenger>::Capacity: TypeInfo + 'static, BlockNumberFor<T>: TypeInfo + 'static, CodeChangeKind<BlockNumberFor<T>>: TypeInfo + 'static, ProgramChangeKind<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 T::AccountId: Encode, Option<BlockNumberFor<T>>: Encode, <<T as Config>::Messenger as Messenger>::Capacity: Encode, BlockNumberFor<T>: Encode, CodeChangeKind<BlockNumberFor<T>>: Encode, ProgramChangeKind<BlockNumberFor<T>>: Encode,

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