Enum serenity::model::event::Event

#[non_exhaustive]
pub enum Event {
    ChannelCreate(ChannelCreateEvent),
    ChannelDelete(ChannelDeleteEvent),
    ChannelPinsUpdate(ChannelPinsUpdateEvent),
    ChannelUpdate(ChannelUpdateEvent),
    GuildBanAdd(GuildBanAddEvent),
    GuildBanRemove(GuildBanRemoveEvent),
    GuildCreate(GuildCreateEvent),
    GuildDelete(GuildDeleteEvent),
    GuildEmojisUpdate(GuildEmojisUpdateEvent),
    GuildIntegrationsUpdate(GuildIntegrationsUpdateEvent),
    GuildMemberAdd(GuildMemberAddEvent),
    GuildMemberRemove(GuildMemberRemoveEvent),
    GuildMemberUpdate(GuildMemberUpdateEvent),
    GuildMembersChunk(GuildMembersChunkEvent),
    GuildRoleCreate(GuildRoleCreateEvent),
    GuildRoleDelete(GuildRoleDeleteEvent),
    GuildRoleUpdate(GuildRoleUpdateEvent),
    GuildUnavailable(GuildUnavailableEvent),
    GuildUpdate(GuildUpdateEvent),
    InviteCreate(InviteCreateEvent),
    InviteDelete(InviteDeleteEvent),
    MessageCreate(MessageCreateEvent),
    MessageDelete(MessageDeleteEvent),
    MessageDeleteBulk(MessageDeleteBulkEvent),
    MessageUpdate(MessageUpdateEvent),
    PresenceUpdate(PresenceUpdateEvent),
    PresencesReplace(PresencesReplaceEvent),
    ReactionAdd(ReactionAddEvent),
    ReactionRemove(ReactionRemoveEvent),
    ReactionRemoveAll(ReactionRemoveAllEvent),
    Ready(ReadyEvent),
    Resumed(ResumedEvent),
    TypingStart(TypingStartEvent),
    UserUpdate(UserUpdateEvent),
    VoiceStateUpdate(VoiceStateUpdateEvent),
    VoiceServerUpdate(VoiceServerUpdateEvent),
    WebhookUpdate(WebhookUpdateEvent),
    InteractionCreate(InteractionCreateEvent),
    IntegrationCreate(IntegrationCreateEvent),
    IntegrationUpdate(IntegrationUpdateEvent),
    IntegrationDelete(IntegrationDeleteEvent),
    ApplicationCommandCreate(ApplicationCommandCreateEvent),
    ApplicationCommandUpdate(ApplicationCommandUpdateEvent),
    ApplicationCommandDelete(ApplicationCommandDeleteEvent),
    StageInstanceCreate(StageInstanceCreateEvent),
    StageInstanceUpdate(StageInstanceUpdateEvent),
    StageInstanceDelete(StageInstanceDeleteEvent),
    ThreadCreate(ThreadCreateEvent),
    ThreadUpdate(ThreadUpdateEvent),
    ThreadDelete(ThreadDeleteEvent),
    ThreadListSync(ThreadListSyncEvent),
    ThreadMemberUpdate(ThreadMemberUpdateEvent),
    ThreadMembersUpdate(ThreadMembersUpdateEvent),
    Unknown(UnknownEvent),
}

Event received over a websocket connection

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(ChannelCreateEvent)

A Channel was created.

Fires the EventHandler::channel_create event.

ChannelDelete(ChannelDeleteEvent)

A Channel has been deleted.

Fires the EventHandler::channel_delete event.

ChannelPinsUpdate(ChannelPinsUpdateEvent)

The pins for a Channel have been updated.

Fires the EventHandler::channel_pins_update event.

ChannelUpdate(ChannelUpdateEvent)

A Channel has been updated.

Fires the EventHandler::channel_update event.

GuildBanAdd(GuildBanAddEvent)

GuildBanRemove(GuildBanRemoveEvent)

GuildCreate(GuildCreateEvent)

GuildDelete(GuildDeleteEvent)

GuildEmojisUpdate(GuildEmojisUpdateEvent)

GuildIntegrationsUpdate(GuildIntegrationsUpdateEvent)

GuildMemberAdd(GuildMemberAddEvent)

GuildMemberRemove(GuildMemberRemoveEvent)

GuildMemberUpdate(GuildMemberUpdateEvent)

A member’s roles have changed

GuildMembersChunk(GuildMembersChunkEvent)

GuildRoleCreate(GuildRoleCreateEvent)

GuildRoleDelete(GuildRoleDeleteEvent)

GuildRoleUpdate(GuildRoleUpdateEvent)

GuildUnavailable(GuildUnavailableEvent)

When a guild is unavailable, such as due to a Discord server outage.

GuildUpdate(GuildUpdateEvent)

InviteCreate(InviteCreateEvent)

An Invite was created.

Fires the EventHandler::invite_create event handler.

InviteDelete(InviteDeleteEvent)

An Invite was deleted.

Fires the EventHandler::invite_delete event handler.

MessageCreate(MessageCreateEvent)

MessageDelete(MessageDeleteEvent)

MessageDeleteBulk(MessageDeleteBulkEvent)

MessageUpdate(MessageUpdateEvent)

A message has been edited, either by the user or the system

PresenceUpdate(PresenceUpdateEvent)

A member’s presence state (or username or avatar) has changed

PresencesReplace(PresencesReplaceEvent)

The precense list of the user’s friends should be replaced entirely

ReactionAdd(ReactionAddEvent)

A reaction was added to a message.

Fires the EventHandler::reaction_add event handler.

ReactionRemove(ReactionRemoveEvent)

A reaction was removed to a message.

Fires the EventHandler::reaction_remove event handler.

ReactionRemoveAll(ReactionRemoveAllEvent)

A request was issued to remove all Reactions from a Message.

Fires the EventHandler::reaction_remove_all event handler.

Ready(ReadyEvent)

The first event in a connection, containing the initial ready cache.

May also be received at a later time in the event of a reconnect.

Resumed(ResumedEvent)

The connection has successfully resumed after a disconnect.

TypingStart(TypingStartEvent)

A user is typing; considered to last 5 seconds

UserUpdate(UserUpdateEvent)

Update to the logged-in user’s information

VoiceStateUpdate(VoiceStateUpdateEvent)

A member’s voice state has changed

VoiceServerUpdate(VoiceServerUpdateEvent)

Voice server information is available

WebhookUpdate(WebhookUpdateEvent)

A webhook for a channel was updated in a Guild.

InteractionCreate(InteractionCreateEvent)

An interaction was created.

IntegrationCreate(IntegrationCreateEvent)

A guild integration was created

IntegrationUpdate(IntegrationUpdateEvent)

A guild integration was updated

IntegrationDelete(IntegrationDeleteEvent)

A guild integration was deleted

ApplicationCommandCreate(ApplicationCommandCreateEvent)

👎 Deprecated since 0.10.10:

bots do no receive this event

An application command was created

ApplicationCommandUpdate(ApplicationCommandUpdateEvent)

👎 Deprecated since 0.10.10:

bots do no receive this event

An application command was updated

ApplicationCommandDelete(ApplicationCommandDeleteEvent)

👎 Deprecated since 0.10.10:

bots do no receive this event

An application command was deleted

StageInstanceCreate(StageInstanceCreateEvent)

A stage instance was created.

StageInstanceUpdate(StageInstanceUpdateEvent)

A stage instance was updated.

StageInstanceDelete(StageInstanceDeleteEvent)

A stage instance was deleted.

ThreadCreate(ThreadCreateEvent)

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

ThreadUpdate(ThreadUpdateEvent)

A thread was updated.

ThreadDelete(ThreadDeleteEvent)

A thread was deleted.

ThreadListSync(ThreadListSyncEvent)

The current user gains access to a channel.

ThreadMemberUpdate(ThreadMemberUpdateEvent)

The ThreadMember object for the current user is updated.

ThreadMembersUpdate(ThreadMembersUpdateEvent)

Anyone is added to or removed from a thread. If the current user does not have the GatewayIntents::GUILDS, then this event will only be sent if the current user was added to or removed from the thread.

Unknown(UnknownEvent)

An event type not covered by the above

Implementations

impl Event

pub fn event_type(&self) -> EventType

Return the type of this event.

pub fn user_id(&self) -> RelatedId<UserId>

User ID(s) related to this event.

pub fn guild_id(&self) -> RelatedId<GuildId>

Guild ID related to this event.

pub fn channel_id(&self) -> RelatedId<ChannelId>

Channel ID(s) related to this event.

pub fn message_id(&self) -> RelatedId<MessageId>

Message ID(s) related to this event.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<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 Serialize for Event

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.