Struct slashy::framework::Framework

pub struct Framework<T: SettingsProvider> { /* fields omitted */ }

The command framework, holds all commands and settings

Implementations

impl<T: SettingsProvider> Framework<T>

pub async fn new(settings: T, application_id: u64, token: String) -> Self

Creates a new Framework

pub fn command<C: CommandInit>(self) -> Self

Adds a command

pub fn event_handler<E: EventHandler + 'static>(self, handler: E) -> Self

Adds an EventHandler to run alongside the framework.

Needed because Serenity does not allow more than one EventHandler registered at once and the framework uses it for commands.

pub async fn register_slash_command(
    &self,
    http: &Http,
    cmd: &Command,
    guild_id: Option<GuildId>
) -> Result<()>

Register a Command as a slash command

If guild_id is None then the command is registered globally

Trait Implementations

impl<T: SettingsProvider + Send + Sync> EventHandler for Framework<T>

fn cache_ready<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    e: Vec<GuildId>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn channel_pins_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    e: ChannelPinsUpdateEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a pin is added, deleted.

fn channel_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    o: Option<Channel>,
    n: Channel
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a channel is updated.

fn guild_ban_addition<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    b: User
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a user is banned from a guild.

fn guild_ban_removal<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    b: User
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn guild_create<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: Guild,
    i: bool
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn guild_delete<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    i: GuildUnavailable,
    f: Option<Guild>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a guild is deleted.

fn guild_emojis_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    c: HashMap<EmojiId, Emoji>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when the emojis are updated.

fn guild_integrations_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn guild_member_addition<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    m: Member
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a user joins a guild.

fn guild_member_removal<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    u: User,
    m: Option<Member>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn guild_member_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    o: Option<Member>,
    n: Member
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn guild_members_chunk<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    c: GuildMembersChunkEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when the data for offline members was requested.

fn guild_role_create<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    n: Role
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a role is created.

fn guild_role_delete<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    r: RoleId,
    ro: Option<Role>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a role is deleted.

fn guild_role_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    o: Option<Role>,
    n: Role
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a role is updated.

fn guild_unavailable<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a guild became unavailable.

fn guild_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    o: Option<Guild>,
    n: PartialGuild
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when the guild is updated.

fn invite_create<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    d: InviteCreateEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a invite is created.

fn invite_delete<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    d: InviteDeleteEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a invite is deleted.

fn message_delete<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    c: ChannelId,
    d: MessageId,
    g: Option<GuildId>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a message is deleted.

fn message_delete_bulk<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    c: ChannelId,
    m: Vec<MessageId>,
    g: Option<GuildId>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when multiple messages were deleted at once.

fn message_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    o: Option<Message>,
    n: Option<Message>,
    e: MessageUpdateEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a message is updated.

fn reaction_add<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    a: Reaction
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a new reaction is attached to a message.

fn reaction_remove<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    r: Reaction
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a reaction is detached from a message.

fn reaction_remove_all<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    c: ChannelId,
    r: MessageId
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn presence_replace<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    a: Vec<Presence>
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn presence_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    n: PresenceUpdateEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn resume<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    a: ResumedEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched upon reconnection.

fn shard_stage_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    a: ShardStageUpdateEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a shard’s connection stage is updated

fn typing_start<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    a: TypingStartEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a user starts typing.

fn unknown<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    n: String,
    a: Value
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when an unknown event was sent from discord.

fn user_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    o: CurrentUser,
    n: CurrentUser
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when the bot’s data is updated.

fn voice_server_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    a: VoiceServerUpdateEvent
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn voice_state_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    a: Option<GuildId>,
    o: Option<VoiceState>,
    n: VoiceState
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn webhook_update<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    g: GuildId,
    b: ChannelId
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a guild’s webhook is updated.

fn channel_create<'life0, 'a, 'async_trait>(
    &'life0 self,
    ctx: Context,
    e: &'a GuildChannel
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    'a: 'async_trait,
    Self: 'async_trait, 

Dispatched when a channel is created.

fn category_create<'life0, 'a, 'async_trait>(
    &'life0 self,
    ctx: Context,
    e: &'a ChannelCategory
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    'a: 'async_trait,
    Self: 'async_trait, 

Dispatched when a category is created.

fn category_delete<'life0, 'a, 'async_trait>(
    &'life0 self,
    ctx: Context,
    e: &'a ChannelCategory
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    'a: 'async_trait,
    Self: 'async_trait, 

Dispatched when a category is deleted.

fn channel_delete<'life0, 'a, 'async_trait>(
    &'life0 self,
    ctx: Context,
    e: &'a GuildChannel
) -> BoxFuture<'async_trait, ()> where
    'life0: 'async_trait,
    'a: 'async_trait,
    Self: 'async_trait, 

Dispatched when a channel is deleted.

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, 

Dispatched upon startup.

fn message<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context,
    message: Message
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a message is created.

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, 

Dispatched when a user used a slash command.

#[must_use]

fn integration_create<'life0, 'async_trait>(
    &'life0 self,
    _ctx: Context,
    _integration: Integration
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a guild integration is created.

#[must_use]

fn integration_update<'life0, 'async_trait>(
    &'life0 self,
    _ctx: Context,
    _integration: Integration
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a guild integration is updated.

#[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 = ()> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when a guild integration is deleted.

#[must_use]

fn application_command_create<'life0, 'async_trait>(
    &'life0 self,
    _ctx: Context,
    _application_command: ApplicationCommand
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when an application command is created.

#[must_use]

fn application_command_update<'life0, 'async_trait>(
    &'life0 self,
    _ctx: Context,
    _application_command: ApplicationCommand
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when an application command is updated.

#[must_use]

fn application_command_delete<'life0, 'async_trait>(
    &'life0 self,
    _ctx: Context,
    _application_command: ApplicationCommand
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatched when an application command is deleted.