Enum serenity::model::event::EventType

#[non_exhaustive]
pub enum EventType {
    ChannelCreate,
    ChannelDelete,
    ChannelPinsUpdate,
    ChannelUpdate,
    GuildBanAdd,
    GuildBanRemove,
    GuildCreate,
    GuildDelete,
    GuildEmojisUpdate,
    GuildIntegrationsUpdate,
    GuildMemberAdd,
    GuildMemberRemove,
    GuildMemberUpdate,
    GuildMembersChunk,
    GuildRoleCreate,
    GuildRoleDelete,
    GuildRoleUpdate,
    GuildUnavailable,
    GuildUpdate,
    InviteCreate,
    InviteDelete,
    MessageCreate,
    MessageDelete,
    MessageDeleteBulk,
    MessageUpdate,
    PresenceUpdate,
    PresencesReplace,
    ReactionAdd,
    ReactionRemove,
    ReactionRemoveAll,
    Ready,
    Resumed,
    TypingStart,
    UserUpdate,
    VoiceStateUpdate,
    VoiceServerUpdate,
    WebhookUpdate,
    InteractionCreate,
    IntegrationCreate,
    IntegrationUpdate,
    IntegrationDelete,
    ApplicationCommandCreate,
    ApplicationCommandUpdate,
    ApplicationCommandDelete,
    StageInstanceCreate,
    StageInstanceUpdate,
    StageInstanceDelete,
    ThreadCreate,
    ThreadUpdate,
    ThreadDelete,
    ThreadListSync,
    ThreadMemberUpdate,
    ThreadMembersUpdate,
    Other(String),
}

The type of event dispatch received from the gateway.

This is useful for deciding how to deserialize a received payload.

A Deserialization implementation is provided for deserializing raw event dispatch type strings to this enum, e.g. deserializing "CHANNEL_CREATE" to EventType::ChannelCreate.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ChannelCreate

Indicator that a channel create payload was received.

This maps to ChannelCreateEvent.

ChannelDelete

Indicator that a channel delete payload was received.

This maps to ChannelDeleteEvent.

ChannelPinsUpdate

Indicator that a channel pins update payload was received.

This maps to ChannelPinsUpdateEvent.

ChannelUpdate

Indicator that a channel update payload was received.

This maps to ChannelUpdateEvent.

GuildBanAdd

Indicator that a guild ban addition payload was received.

This maps to GuildBanAddEvent.

GuildBanRemove

Indicator that a guild ban removal payload was received.

This maps to GuildBanRemoveEvent.

GuildCreate

Indicator that a guild create payload was received.

This maps to GuildCreateEvent.

GuildDelete

Indicator that a guild delete payload was received.

This maps to GuildDeleteEvent.

GuildEmojisUpdate

Indicator that a guild emojis update payload was received.

This maps to GuildEmojisUpdateEvent.

GuildIntegrationsUpdate

Indicator that a guild integrations update payload was received.

This maps to GuildIntegrationsUpdateEvent.

GuildMemberAdd

Indicator that a guild member add payload was received.

This maps to GuildMemberAddEvent.

GuildMemberRemove

Indicator that a guild member remove payload was received.

This maps to GuildMemberRemoveEvent.

GuildMemberUpdate

Indicator that a guild member update payload was received.

This maps to GuildMemberUpdateEvent.

GuildMembersChunk

Indicator that a guild members chunk payload was received.

This maps to GuildMembersChunkEvent.

GuildRoleCreate

Indicator that a guild role create payload was received.

This maps to GuildRoleCreateEvent.

GuildRoleDelete

Indicator that a guild role delete payload was received.

This maps to GuildRoleDeleteEvent.

GuildRoleUpdate

Indicator that a guild role update payload was received.

This maps to GuildRoleUpdateEvent.

GuildUnavailable

Indicator that a guild unavailable payload was received.

This maps to GuildUnavailableEvent.

GuildUpdate

Indicator that a guild update payload was received.

This maps to GuildUpdateEvent.

InviteCreate

Indicator that an invite was created.

This maps to InviteCreateEvent.

InviteDelete

Indicator that an invite was deleted.

This maps to InviteDeleteEvent.

MessageCreate

Indicator that a message create payload was received.

This maps to MessageCreateEvent.

MessageDelete

Indicator that a message delete payload was received.

This maps to MessageDeleteEvent.

MessageDeleteBulk

Indicator that a message delete bulk payload was received.

This maps to MessageDeleteBulkEvent.

MessageUpdate

Indicator that a message update payload was received.

This maps to MessageUpdateEvent.

PresenceUpdate

Indicator that a presence update payload was received.

This maps to PresenceUpdateEvent.

PresencesReplace

Indicator that a presences replace payload was received.

This maps to PresencesReplaceEvent.

ReactionAdd

Indicator that a reaction add payload was received.

This maps to ReactionAddEvent.

ReactionRemove

Indicator that a reaction remove payload was received.

This maps to ReactionRemoveEvent.

ReactionRemoveAll

Indicator that a reaction remove all payload was received.

This maps to ReactionRemoveAllEvent.

Ready

Indicator that a ready payload was received.

This maps to ReadyEvent.

Resumed

Indicator that a resumed payload was received.

This maps to ResumedEvent.

TypingStart

Indicator that a typing start payload was received.

This maps to TypingStartEvent.

UserUpdate

Indicator that a user update payload was received.

This maps to UserUpdateEvent.

VoiceStateUpdate

Indicator that a voice state payload was received.

This maps to VoiceStateUpdateEvent.

VoiceServerUpdate

Indicator that a voice server update payload was received.

This maps to VoiceServerUpdateEvent.

WebhookUpdate

Indicator that a webhook update payload was received.

This maps to WebhookUpdateEvent.

InteractionCreate

Indicator that an interaction was created.

This maps to InteractionCreateEvent.

IntegrationCreate

Indicator that an integration was created.

This maps to IntegrationCreateEvent.

IntegrationUpdate

Indicator that an integration was created.

This maps to IntegrationUpdateEvent.

IntegrationDelete

Indicator that an integration was created.

This maps to IntegrationDeleteEvent.

ApplicationCommandCreate

👎 Deprecated since 0.10.10:

bots do no receive this event

Indicator that an application command was created.

This maps to ApplicationCommandCreateEvent.

ApplicationCommandUpdate

👎 Deprecated since 0.10.10:

bots do no receive this event

Indicator that an application command was updated.

This maps to ApplicationCommandUpdateEvent.

ApplicationCommandDelete

👎 Deprecated since 0.10.10:

bots do no receive this event

Indicator that an application command was deleted.

This maps to ApplicationCommandDeleteEvent.

StageInstanceCreate

Indicator that a stage instance was created.

This maps to StageInstanceCreateEvent.

StageInstanceUpdate

Indicator that a stage instance was updated.

This maps to StageInstanceUpdateEvent.

StageInstanceDelete

Indicator that a stage instance was deleted.

This maps to StageInstanceDeleteEvent.

ThreadCreate

Indicator that a thread was created or the current user was added to a private thread.

This maps to ThreadCreateEvent.

ThreadUpdate

Indicator that a thread was updated.

This maps to ThreadUpdateEvent.

ThreadDelete

Indicator that a thread was deleted.

This maps to ThreadDeleteEvent.

ThreadListSync

Indicator that the current user gains access to a channel.

This maps to ThreadListSyncEvent

ThreadMemberUpdate

Indicator that the ThreadMember object for the current user is updated.

This maps to ThreadMemberUpdateEvent

ThreadMembersUpdate

Indicator that anyone is added to or removed from a thread.

This maps to ThreadMembersUpdateEvent

Other(String)

Tuple Fields

0: String

An unknown event was received over the gateway.

This should be logged so that support for it can be added in the library.

Implementations

impl EventType

pub fn name(&self) -> Option<&str>

Return the event name of this event. Some events are synthetic, and we lack the information to recover the original event name for these events, in which case this method returns None.

pub fn related_ids(&self) -> RelatedIdsForEventType

Trait Implementations

impl Clone for EventType

fn clone(&self) -> EventType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventType

fn deserialize<D>(deserializer: D) -> StdResult<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<&'_ Event> for EventType

fn from(event: &Event) -> EventType

Performs the conversion.

impl Ord for EventType

fn cmp(&self, other: &EventType) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<EventType> for EventType

fn eq(&self, other: &EventType) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<EventType> for EventType

fn partial_cmp(&self, other: &EventType) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for EventType

impl StructuralEq for EventType

impl StructuralPartialEq for EventType