Trait serenity::prelude::EventHandler[−][src]

pub trait EventHandler: Send + Sync {

Show methods    #[must_use]
    fn cache_ready<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guilds: Vec<GuildId>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn channel_create<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _channel: &'life1 GuildChannel
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn category_create<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _category: &'life1 ChannelCategory
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn category_delete<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _category: &'life1 ChannelCategory
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn channel_delete<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _channel: &'life1 GuildChannel
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn channel_pins_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _pin: ChannelPinsUpdateEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn channel_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _old: Option<Channel>, 
        _new: Channel
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_ban_addition<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _banned_user: User
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_ban_removal<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _unbanned_user: User
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_create<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild: Guild, 
        _is_new: bool
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_delete<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _incomplete: GuildUnavailable, 
        _full: Option<Guild>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_emojis_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _current_state: HashMap<EmojiId, Emoji>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_integrations_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_member_addition<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _new_member: Member
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_member_removal<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _user: User, 
        _member_data_if_available: Option<Member>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_member_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _old_if_available: Option<Member>, 
        _new: Member
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_members_chunk<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _chunk: GuildMembersChunkEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_role_create<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _new: Role
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_role_delete<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _removed_role_id: RoleId, 
        _removed_role_data_if_available: Option<Role>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_role_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _old_data_if_available: Option<Role>, 
        _new: Role
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_unavailable<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn guild_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _old_data_if_available: Option<Guild>, 
        _new_but_incomplete: PartialGuild
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn invite_create<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _data: InviteCreateEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn invite_delete<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _data: InviteDeleteEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn message<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _new_message: Message
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn message_delete<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _channel_id: ChannelId, 
        _deleted_message_id: MessageId, 
        _guild_id: Option<GuildId>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn message_delete_bulk<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _channel_id: ChannelId, 
        _multiple_deleted_messages_ids: Vec<MessageId>, 
        _guild_id: Option<GuildId>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn message_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _old_if_available: Option<Message>, 
        _new: Option<Message>, 
        _event: MessageUpdateEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn reaction_add<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _add_reaction: Reaction
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn reaction_remove<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _removed_reaction: Reaction
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn reaction_remove_all<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _channel_id: ChannelId, 
        _removed_from_message_id: MessageId
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn presence_replace<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        __arg2: Vec<Presence>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn presence_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _new_data: PresenceUpdateEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn ready<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _data_about_bot: Ready
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn resume<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        __arg2: ResumedEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn shard_stage_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        __arg2: ShardStageUpdateEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn typing_start<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        __arg2: TypingStartEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn unknown<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _name: String, 
        _raw: Value
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn user_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _old_data: CurrentUser, 
        _new: CurrentUser
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn voice_server_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        __arg2: VoiceServerUpdateEvent
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn voice_state_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        __arg2: Option<GuildId>, 
        _old: Option<VoiceState>, 
        _new: VoiceState
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn webhook_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _guild_id: GuildId, 
        _belongs_to_channel_id: ChannelId
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn interaction_create<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _interaction: Interaction
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn integration_create<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _integration: Integration
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn integration_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _integration: Integration
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn integration_delete<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _integration_id: IntegrationId, 
        _guild_id: GuildId, 
        _application_id: Option<ApplicationId>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn application_command_create<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _application_command: ApplicationCommand
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn application_command_update<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _application_command: ApplicationCommand
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn application_command_delete<'life0, 'async_trait>(
        &'life0 self, 
        _ctx: Context, 
        _application_command: ApplicationCommand
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

}
Expand description

The core trait for handling events by serenity.

Provided methods

Dispatched when the cache has received and inserted all data from guilds.

This process happens upon starting your bot and should be fairly quick. However, cache actions performed prior this event may fail as the data could be not inserted yet.

Provides the cached guilds’ ids.

Dispatched when a channel is created.

Provides said channel’s data.

Dispatched when a category is created.

Provides said category’s data.

Dispatched when a category is deleted.

Provides said category’s data.

Dispatched when a channel is deleted.

Provides said channel’s data.

Dispatched when a pin is added, deleted.

Provides said pin’s data.

Dispatched when a channel is updated.

Provides the old channel data, and the new data.

Dispatched when a user is banned from a guild.

Provides the guild’s id and the banned user’s data.

Dispatched when a user’s ban is lifted from a guild.

Provides the guild’s id and the lifted user’s data.

Dispatched when a guild is created; or an existing guild’s data is sent to us.

Provides the guild’s data and whether the guild is new.

Dispatched when a guild is deleted.

Provides the partial data of the guild sent by discord, and the full data from the cache, if available.

The unavailable flag in the partial data determines the status of the guild. If the flag is false, the bot was removed from the guild, either by being kicked or banned. If the flag is true, the guild went offline.

Dispatched when the emojis are updated.

Provides the guild’s id and the new state of the emojis in the guild.

Dispatched when a guild’s integration is added, updated or removed.

Provides the guild’s id.

Dispatched when a user joins a guild.

Provides the guild’s id and the user’s member data.

Note: This event will not trigger unless the “guild members” privileged intent is enabled on the bot application page.

Dispatched when a user’s membership ends by leaving, getting kicked, or being banned.

Provides the guild’s id, the user’s data, and the user’s member data if available.

Note: This event will not trigger unless the “guild members” privileged intent is enabled on the bot application page.

Dispatched when a member is updated (e.g their nickname is updated).

Provides the member’s old data (if available) and the new data.

Note: This event will not trigger unless the “guild members” privileged intent is enabled on the bot application page.

Dispatched when the data for offline members was requested.

Provides the guild’s id and the data.

Dispatched when a role is created.

Provides the guild’s id and the new role’s data.

Dispatched when a role is deleted.

Provides the guild’s id, the role’s id and its data if available.

Dispatched when a role is updated.

Provides the guild’s id, the role’s old (if available) and new data.

Dispatched when a guild became unavailable.

Provides the guild’s id.

Dispatched when the guild is updated.

Provides the guild’s old full data (if available) and the new, albeit partial data.

Dispatched when a invite is created.

Provides data about the invite.

Dispatched when a invite is deleted.

Provides data about the invite.

Dispatched when a message is created.

Provides the message’s data.

Dispatched when a message is deleted.

Provides the guild’s id, the channel’s id and the message’s id.

Dispatched when multiple messages were deleted at once.

Provides the guild’s id, channel’s id and the deleted messages’ ids.

Dispatched when a message is updated.

Provides the old message if available, the new message as an option in case of cache inconsistencies, and the raw MessageUpdateEvent as a fallback.

Dispatched when a new reaction is attached to a message.

Provides the reaction’s data.

Dispatched when a reaction is detached from a message.

Provides the reaction’s data.

Dispatched when all reactions of a message are detached from a message.

Provides the channel’s id and the message’s id.

This event is legacy, and likely no longer sent by discord.

Dispatched when a user’s presence is updated (e.g off -> on).

Provides the presence’s new data.

Note: This event will not trigger unless the “guild presences” privileged intent is enabled on the bot application page.

Dispatched upon startup.

Provides data about the bot and the guilds it’s in.

Dispatched upon reconnection.

Dispatched when a shard’s connection stage is updated

Provides the context of the shard and the event information about the update.

Dispatched when a user starts typing.

Dispatched when an unknown event was sent from discord.

Provides the event’s name and its unparsed data.

Dispatched when the bot’s data is updated.

Provides the old and new data.

Dispatched when a guild’s voice server was updated (or changed to another one).

Provides the voice server’s data.

Dispatched when a user joins, leaves or moves to a voice channel.

Provides the guild’s id (if available) and the old and the new state of the guild’s voice channels.

Dispatched when a guild’s webhook is updated.

Provides the guild’s id and the channel’s id the webhook belongs in.

This is supported on crate feature unstable_discord_api only.

Dispatched when a user used a slash command.

Provides the created interaction.

This is supported on crate feature unstable_discord_api only.

Dispatched when a guild integration is created.

Provides the created integration.

This is supported on crate feature unstable_discord_api only.

Dispatched when a guild integration is updated.

Provides the updated integration.

This is supported on crate feature unstable_discord_api only.

Dispatched when a guild integration is deleted.

Provides the integration’s id, the id of the guild it belongs to, and its associated application id

This is supported on crate feature unstable_discord_api only.

Dispatched when an application command is created.

Provides the created application command.

This is supported on crate feature unstable_discord_api only.

Dispatched when an application command is updated.

Provides the updated application command.

This is supported on crate feature unstable_discord_api only.

Dispatched when an application command is deleted.

Provides the deleted application command.

Implementors