fluxer-rust 0.2.0

//! The event handler trait for reacting to gateway events.
//!
//! Implement [`EventHandler`] on your own struct and pass it to the client builder.
//! Every method has a default no-op implementation so you only need to override
//! the ones you care about.
//!
//! Events are dispatched concurrently -- each one runs in its own spawned task.
//! Because of this, the trait requires `Send + Sync`. If you need shared mutable
//! state in your handler, wrap it in `Arc<Mutex<T>>`.

use async_trait::async_trait;
use crate::client::Context;
use crate::model::*;

/// Trait for handling gateway events. Implement the methods you need, ignore the rest.
///
/// ```rust,no_run
/// use fluxer::prelude::*;
/// use async_trait::async_trait;
///
/// struct Bot;
///
/// #[async_trait]
/// impl EventHandler for Bot {
///     async fn on_message(&self, ctx: Context, msg: Message) {
///         if msg.content.as_deref() == Some("!hello") {
///             let ch = msg.channel_id.as_deref().unwrap_or_default();
///             let _ = ctx.http.send_message(ch, "Hello!").await;
///         }
///     }
/// }
/// ```
#[async_trait]
pub trait EventHandler: Send + Sync {
    /// The bot is connected and ready. [`Ready`] contains the bot user, session ID,
    /// and initial guild list.
    async fn on_ready(&self, _ctx: Context, _ready: Ready) {}

    async fn on_message(&self, _ctx: Context, _msg: Message) {}

    /// Only the changed fields are populated in [`MessageUpdate`].
    async fn on_message_update(&self, _ctx: Context, _update: MessageUpdate) {}

    /// You only get the ID, not the content.
    async fn on_message_delete(&self, _ctx: Context, _delete: MessageDelete) {}

    async fn on_message_delete_bulk(&self, _ctx: Context, _delete: MessageDeleteBulk) {}

    async fn on_reaction_add(&self, _ctx: Context, _reaction: ReactionAdd) {}

    async fn on_reaction_remove(&self, _ctx: Context, _reaction: ReactionRemove) {}

    async fn on_reaction_remove_all(&self, _ctx: Context, _event: ReactionRemoveAll) {}

    async fn on_reaction_remove_emoji(&self, _ctx: Context, _event: ReactionRemoveEmoji) {}

    async fn on_typing_start(&self, _ctx: Context, _event: TypingStart) {}

    async fn on_channel_create(&self, _ctx: Context, _channel: Channel) {}

    async fn on_channel_update(&self, _ctx: Context, _channel: Channel) {}

    async fn on_channel_delete(&self, _ctx: Context, _channel: Channel) {}

    async fn on_channel_pins_update(&self, _ctx: Context, _event: ChannelPinsUpdate) {}

    /// Fired when the bot joins a guild or when a guild becomes available after an outage.
    async fn on_guild_create(&self, _ctx: Context, _guild: Guild) {}

    async fn on_guild_update(&self, _ctx: Context, _guild: Guild) {}

    /// The bot was removed from the guild, or the guild went unavailable.
    async fn on_guild_delete(&self, _ctx: Context, _guild: UnavailableGuild) {}

    async fn on_guild_member_add(&self, _ctx: Context, _event: GuildMemberAdd) {}

    async fn on_guild_member_update(&self, _ctx: Context, _event: GuildMemberUpdate) {}

    async fn on_guild_member_remove(&self, _ctx: Context, _event: GuildMemberRemove) {}

    async fn on_guild_ban_add(&self, _ctx: Context, _event: GuildBanAdd) {}

    async fn on_guild_ban_remove(&self, _ctx: Context, _event: GuildBanRemove) {}

    async fn on_guild_role_create(&self, _ctx: Context, _event: GuildRoleCreate) {}

    async fn on_guild_role_update(&self, _ctx: Context, _event: GuildRoleUpdate) {}

    async fn on_guild_role_delete(&self, _ctx: Context, _event: GuildRoleDelete) {}

    async fn on_guild_emojis_update(&self, _ctx: Context, _event: GuildEmojisUpdate) {}

    async fn on_guild_stickers_update(&self, _ctx: Context, _event: GuildStickersUpdate) {}

    async fn on_guild_role_update_bulk(&self, _ctx: Context, _event: GuildRoleUpdateBulk) {}

    async fn on_channel_update_bulk(&self, _ctx: Context, _event: ChannelUpdateBulk) {}

    async fn on_invite_create(&self, _ctx: Context, _event: InviteCreate) {}

    async fn on_invite_delete(&self, _ctx: Context, _event: InviteDelete) {}

    async fn on_webhooks_update(&self, _ctx: Context, _event: WebhooksUpdate) {}

    async fn on_presence_update(&self, _ctx: Context, _event: PresenceUpdate) {}

    async fn on_presence_update_bulk(&self, _ctx: Context, _event: PresenceUpdateBulk) {}

    async fn on_user_settings_update(&self, _ctx: Context, _event: UserSettingsUpdate) {}

    async fn on_user_update(&self, _ctx: Context, _event: UserUpdate) {}

    async fn on_message_ack(&self, _ctx: Context, _event: MessageAck) {}

    async fn on_sessions_replace(&self, _ctx: Context, _event: SessionsReplace) {}

    async fn on_relationship_add(&self, _ctx: Context, _event: RelationshipAdd) {}

    async fn on_relationship_update(&self, _ctx: Context, _event: RelationshipUpdate) {}

    async fn on_relationship_remove(&self, _ctx: Context, _event: RelationshipRemove) {}

    async fn on_call_create(&self, _ctx: Context, _event: CallCreate) {}

    async fn on_call_update(&self, _ctx: Context, _event: CallUpdate) {}

    async fn on_call_delete(&self, _ctx: Context, _event: CallDelete) {}

    async fn on_channel_recipient_add(&self, _ctx: Context, _event: ChannelRecipientAdd) {}

    async fn on_channel_recipient_remove(&self, _ctx: Context, _event: ChannelRecipientRemove) {}

    async fn on_message_reaction_add_many(&self, _ctx: Context, _event: MessageReactionAddMany) {}

    async fn on_passive_updates(&self, _ctx: Context, _event: PassiveUpdates) {}

    async fn on_guild_member_list_update(&self, _ctx: Context, _event: GuildMemberListUpdate) {}

    async fn on_guild_sync(&self, _ctx: Context, _event: GuildSync) {}

    async fn on_guild_audit_log_entry_create(&self, _ctx: Context, _event: GuildAuditLogEntryCreate) {}

    async fn on_unknown_event(&self, _ctx: Context, _event_type: String, _data: serde_json::Value) {}

    async fn on_guild_members_chunk(&self, _ctx: Context, _event: GuildMembersChunk) {}

    async fn on_voice_state_update(&self, _ctx: Context, _event: VoiceStateUpdate) {}

    async fn on_voice_server_update(&self, _ctx: Context, _event: VoiceServerUpdate) {}

    async fn on_resumed(&self, _ctx: Context, _event: Resumed) {}

    async fn on_channel_pins_ack(&self, _ctx: Context, _event: ChannelPinsAck) {}

    async fn on_user_pinned_dms_update(&self, _ctx: Context, _event: UserPinnedDmsUpdate) {}

    async fn on_user_note_update(&self, _ctx: Context, _event: UserNoteUpdate) {}

    async fn on_user_connections_update(&self, _ctx: Context, _event: UserConnectionsUpdate) {}

    async fn on_user_guild_settings_update(&self, _ctx: Context, _event: UserGuildSettingsUpdate) {}

    async fn on_auth_session_change(&self, _ctx: Context, _event: AuthSessionChange) {}

    async fn on_saved_message_create(&self, _ctx: Context, _event: SavedMessageCreate) {}

    async fn on_saved_message_delete(&self, _ctx: Context, _event: SavedMessageDelete) {}

    async fn on_recent_mention_delete(&self, _ctx: Context, _event: RecentMentionDelete) {}

    /// Raw PCM frames from a remote voice participant. Fires for every audio frame received.
    async fn on_voice_receive(&self, _ctx: Context, _frame: crate::voice::VoiceFrame) {}
}