diself 0.3.0

A Discord self-bot library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323

use crate::client::{Context, DispatchEvent};
use crate::model::{Message, PassiveUpdateV1, ReadySupplemental, User};
use async_trait::async_trait;
use serde_json::Value;

/// Trait for handling Discord events
///
/// Implement this trait to respond to Discord events.
///
/// # Example
/// ```ignore
/// use diself::prelude::*;
///
/// struct MyBot;
///
/// #[async_trait]
/// impl EventHandler for MyBot {
///     async fn on_ready(&self, ctx: &Context, user: User) {
///         println!("Bot is ready!");
///     }
///     
///     async fn on_message(&self, ctx: &Context, msg: Message) {
///         if msg.content == "!ping" {
///             msg.reply(&ctx.http, "Pong!").await.ok();
///         }
///     }
/// }
/// ```
#[async_trait]
pub trait EventHandler: Send + Sync {
    /// Called for every gateway payload received (all opcodes).
    async fn on_gateway_payload(&self, ctx: &Context, payload: &Value) {
        let _ = (ctx, payload);
    }

    /// Called for every dispatch event (opcode 0), including unknown events.
    async fn on_dispatch(&self, ctx: &Context, event: DispatchEvent) {
        let _ = (ctx, event);
    }

    /// Called when the bot is ready
    async fn on_ready(&self, ctx: &Context, user: User) {
        let _ = (ctx, user);
    }

    /// Called soon after the READY event, and giving extra information about the session
    async fn on_ready_supplemental(&self, ctx: &Context, user: User, data: Value) {
        let _ = (ctx, user, data);
    }

    /// Typed READY_SUPPLEMENTAL callback.
    async fn on_ready_supplemental_typed(
        &self,
        ctx: &Context,
        user: User,
        data: ReadySupplemental,
    ) {
        let _ = (ctx, user, data);
    }

    /// Called for every new message
    async fn on_message_create(&self, ctx: &Context, message: Message) {
        let _ = (ctx, message);
    }

    /// Called when a message is edited
    async fn on_message_update(&self, ctx: &Context, message: Message) {
        let _ = (ctx, message);
    }

    /// Called when a message is deleted
    async fn on_message_delete(&self, ctx: &Context, channel_id: String, message_id: String) {
        let _ = (ctx, channel_id, message_id);
    }

    /// Called when a user is updated
    async fn on_user_update(&self, ctx: &Context, old_user: User, new_user: User) {
        let _ = (ctx, old_user, new_user);
    }

    // ==================== Raw Dispatch Coverage ====================
    // One callback per DispatchEventType (raw JSON payload), discord.js-style coverage.

    async fn on_ready_event(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_ready_supplemental_event(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_resumed_event(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_application_command_permissions_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_auto_moderation_rule_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_auto_moderation_rule_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_auto_moderation_rule_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_auto_moderation_action_execution(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_channel_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_channel_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_channel_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_channel_pins_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_thread_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_thread_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_thread_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_thread_list_sync(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_thread_member_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_thread_members_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_entitlement_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_entitlement_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_entitlement_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_audit_log_entry_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_ban_add(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_ban_remove(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_emojis_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_stickers_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_integrations_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_member_add(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_member_remove(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_member_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_members_chunk(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_role_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_role_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_role_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_scheduled_event_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_scheduled_event_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_scheduled_event_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_scheduled_event_user_add(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_scheduled_event_user_remove(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_soundboard_sound_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_soundboard_sound_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_soundboard_sound_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_guild_soundboard_sounds_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_integration_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_integration_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_integration_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_interaction_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_invite_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_invite_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_create_event(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_update_event(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_delete_event(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_delete_bulk(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_reaction_add(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_reaction_remove(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_reaction_remove_all(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_reaction_remove_emoji(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_poll_vote_add(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_message_poll_vote_remove(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_presence_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_passive_update_v1(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_stage_instance_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_stage_instance_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_stage_instance_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_subscription_create(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_subscription_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_subscription_delete(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_typing_start(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_user_update_event(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_voice_channel_effect_send(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_voice_state_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_voice_server_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_webhooks_update(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_relationship_add(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }
    async fn on_relationship_remove(&self, ctx: &Context, data: Value) {
        let _ = (ctx, data);
    }

    /// Typed PASSIVE_UPDATE_V1 callback.
    async fn on_passive_update_v1_typed(&self, ctx: &Context, data: PassiveUpdateV1) {
        let _ = (ctx, data);
    }
}