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
use bitflags::bitflags;
use serde::{
de::{Deserialize, Deserializer},
ser::{Serialize, Serializer},
};
bitflags! {
/// Gateway intents.
///
/// Developers must specify intents when connecting to the gateway. The
/// intents specified correspond with the events received. To specify
/// multiple intents, create a union using the `|` operator. See [the
/// discord docs] for more information.
///
/// [the discord docs]: https://discord.com/developers/docs/topics/gateway#gateway-intents
pub struct Intents: u64 {
/// Guilds intent.
///
/// Event(s) received:
/// - [`GUILD_CREATE`]
/// - [`GUILD_UPDATE`]
/// - [`GUILD_DELETE`]
/// - [`GUILD_ROLE_CREATE`]
/// - [`GUILD_ROLE_UPDATE`]
/// - [`GUILD_ROLE_DELETE`]
/// - [`CHANNEL_CREATE`]
/// - [`CHANNEL_UPDATE`]
/// - [`CHANNEL_DELETE`]
/// - [`CHANNEL_PINS_UPDATE`]
///
/// [`GUILD_CREATE`]: super::event::Event::GuildCreate
/// [`GUILD_UPDATE`]: super::event::Event::GuildUpdate
/// [`GUILD_DELETE`]: super::event::Event::GuildDelete
/// [`GUILD_ROLE_CREATE`]: super::event::Event::RoleCreate
/// [`GUILD_ROLE_UPDATE`]: super::event::Event::RoleUpdate
/// [`GUILD_ROLE_DELETE`]: super::event::Event::RoleDelete
/// [`CHANNEL_CREATE`]: super::event::Event::ChannelCreate
/// [`CHANNEL_UPDATE`]: super::event::Event::ChannelUpdate
/// [`CHANNEL_DELETE`]: super::event::Event::ChannelDelete
/// [`CHANNEL_PINS_UPDATE`]: super::event::Event::ChannelPinsUpdate
const GUILDS = 1;
/// Guild members intent.
///
/// This intent is privileged. See [the discord docs] for more information.
///
/// Event(s) received:
/// - [`GUILD_MEMBER_ADD`]
/// - [`GUILD_MEMBER_UPDATE`]
/// - [`GUILD_MEMBER_REMOVE`]
///
/// [the discord docs]: https://discord.com/developers/docs/topics/gateway#privileged-intents
/// [`GUILD_MEMBER_ADD`]: super::event::Event::MemberAdd
/// [`GUILD_MEMBER_UPDATE`]: super::event::Event::MemberUpdate
/// [`GUILD_MEMBER_REMOVE`]: super::event::Event::MemberRemove
const GUILD_MEMBERS = 1 << 1;
/// Guild bans intent.
///
/// Event(s) received:
/// - [`GUILD_BAN_ADD`]
/// - [`GUILD_BAN_REMOVE`]
///
/// [`GUILD_BAN_ADD`]: super::event::Event::BanAdd
/// [`GUILD_BAN_REMOVE`]: super::event::Event::BanRemove
const GUILD_BANS = 1 << 2;
/// Guild emojis intent.
///
/// Event(s) received:
/// - [`GUILD_EMOJIS_UPDATE`]
///
/// [`GUILD_EMOJIS_UPDATE`]: super::event::Event::GuildEmojisUpdate
const GUILD_EMOJIS = 1 << 3;
/// Guild integrations intent.
///
/// Event(s) received:
/// - [`GUILD_INTEGRATIONS_UPDATE`]
///
/// [`GUILD_INTEGRATIONS_UPDATE`]: super::event::Event::GuildIntegrationsUpdate
const GUILD_INTEGRATIONS = 1 << 4;
/// Guild webhooks intent.
///
/// Event(s) received:
/// - [`WEBHOOKS_UPDATE`]
///
/// [`WEBHOOKS_UPDATE`]: super::event::Event::WebhooksUpdate
const GUILD_WEBHOOKS = 1 << 5;
/// Guild invites intent.
///
/// Event(s) received:
/// - [`INVITE_CREATE`]
/// - [`INVITE_DELETE`]
///
/// [`INVITE_CREATE`]: super::event::Event::InviteCreate
/// [`INVITE_DELETE`]: super::event::Event::InviteDelete
const GUILD_INVITES = 1 << 6;
/// Guild voice states intent.
///
/// Event(s) received:
/// - [`VOICE_STATE_UPDATE`]
///
/// [`VOICE_STATE_UPDATE`]: super::event::Event::VoiceStateUpdate
const GUILD_VOICE_STATES = 1 << 7;
/// Guild presences intent.
///
/// This intent is privileged. See [the discord docs] for more information.
///
/// Event(s) received:
/// - [`PRESENCE_UPDATE`]
///
/// [the discord docs]: https://discord.com/developers/docs/topics/gateway#privileged-intents
/// [`PRESENCE_UPDATE`]: super::event::Event::PresenceUpdate
const GUILD_PRESENCES = 1 << 8;
/// Guild messages intent.
///
/// Event(s) received:
/// - [`MESSAGE_CREATE`]
/// - [`MESSAGE_UPDATE`]
/// - [`MESSAGE_DELETE`]
/// - [`MESSAGE_DELETE_BULK`]
///
/// [`MESSAGE_CREATE`]: super::event::Event::MessageCreate
/// [`MESSAGE_UPDATE`]: super::event::Event::MessageUpdate
/// [`MESSAGE_DELETE`]: super::event::Event::MessageDelete
/// [`MESSAGE_DELETE_BULK`]: super::event::Event::MessageDeleteBulk
const GUILD_MESSAGES = 1 << 9;
/// Guild message reactions intent.
///
/// Event(s) received:
/// - [`MESSAGE_REACTION_ADD`]
/// - [`MESSAGE_REACTION_REMOVE`]
/// - [`MESSAGE_REACTION_REMOVE_ALL`]
/// - [`MESSAGE_REACTION_REMOVE_EMOJI`]
///
/// [`MESSAGE_REACTION_ADD`]: super::event::Event::ReactionAdd
/// [`MESSAGE_REACTION_REMOVE`]: super::event::Event::ReactionRemove
/// [`MESSAGE_REACTION_REMOVE_ALL`]: super::event::Event::ReactionRemoveAll
/// [`MESSAGE_REACTION_REMOVE_EMOJI`]: super::event::Event::ReactionRemoveEmoji
const GUILD_MESSAGE_REACTIONS = 1 << 10;
/// Guild message typing intent.
///
/// Event(s) received:
/// - [`TYPING_START`]
///
/// [`TYPING_START`]: super::event::Event::TypingStart
const GUILD_MESSAGE_TYPING = 1 << 11;
/// Direct messages intent.
///
/// Event(s) received:
/// - [`MESSAGE_CREATE`]
/// - [`MESSAGE_UPDATE`]
/// - [`MESSAGE_DELETE`]
/// - [`MESSAGE_DELETE_BULK`]
///
/// This is different from the [`GUILD_MESSAGES`] intent in that the bot
/// will receive message events from locations other than guilds.
///
/// [`MESSAGE_CREATE`]: super::event::Event::MessageCreate
/// [`MESSAGE_UPDATE`]: super::event::Event::MessageUpdate
/// [`MESSAGE_DELETE`]: super::event::Event::MessageDelete
/// [`MESSAGE_DELETE_BULK`]: super::event::Event::MessageDeleteBulk
/// [`GUILD_MESSAGES`]: Self::GUILD_MESSAGES
const DIRECT_MESSAGES = 1 << 12;
/// Direct message reactions intent.
///
/// Event(s) received:
/// - [`MESSAGE_REACTION_ADD`]
/// - [`MESSAGE_REACTION_REMOVE`]
/// - [`MESSAGE_REACTION_REMOVE_ALL`]
/// - [`MESSAGE_REACTION_REMOVE_EMOJI`]
///
/// This is different from the [`GUILD_MESSAGE_REACTIONS`] event in that
/// the bot will receive message reaction events from locations other
/// than guilds.
///
/// [`MESSAGE_REACTION_ADD`]: super::event::Event::ReactionAdd
/// [`MESSAGE_REACTION_REMOVE`]: super::event::Event::ReactionRemove
/// [`MESSAGE_REACTION_REMOVE_ALL`]: super::event::Event::ReactionRemoveAll
/// [`MESSAGE_REACTION_REMOVE_EMOJI`]: super::event::Event::ReactionRemoveEmoji
/// [`GUILD_MESSAGE_REACTIONS`]: Self::GUILD_MESSAGE_REACTIONS
const DIRECT_MESSAGE_REACTIONS = 1 << 13;
/// Direct message typing intent.
///
/// Event(s) received:
/// - [`TYPING_START`]
///
/// This is different from the [`GUILD_MESSAGE_TYPING`] intent in that
/// the bot will receive typing start events from locations other than
/// guilds.
///
/// [`TYPING_START`]: super::event::Event::TypingStart
/// [`GUILD_MESSAGE_TYPING`]: Self::GUILD_MESSAGE_TYPING
const DIRECT_MESSAGE_TYPING = 1 << 14;
}
}
impl<'de> Deserialize<'de> for Intents {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
Ok(Self::from_bits_truncate(u64::deserialize(deserializer)?))
}
}
impl Serialize for Intents {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_u64(self.bits())
}
}
#[cfg(test)]
mod tests {
use super::Intents;
use serde_test::Token;
#[test]
fn test_variants() {
serde_test::assert_tokens(&Intents::GUILDS, &[Token::U64(1)]);
serde_test::assert_tokens(&Intents::GUILD_MEMBERS, &[Token::U64(1 << 1)]);
serde_test::assert_tokens(&Intents::GUILD_BANS, &[Token::U64(1 << 2)]);
serde_test::assert_tokens(&Intents::GUILD_EMOJIS, &[Token::U64(1 << 3)]);
serde_test::assert_tokens(&Intents::GUILD_INTEGRATIONS, &[Token::U64(1 << 4)]);
serde_test::assert_tokens(&Intents::GUILD_WEBHOOKS, &[Token::U64(1 << 5)]);
serde_test::assert_tokens(&Intents::GUILD_INVITES, &[Token::U64(1 << 6)]);
serde_test::assert_tokens(&Intents::GUILD_VOICE_STATES, &[Token::U64(1 << 7)]);
serde_test::assert_tokens(&Intents::GUILD_PRESENCES, &[Token::U64(1 << 8)]);
serde_test::assert_tokens(&Intents::GUILD_MESSAGES, &[Token::U64(1 << 9)]);
serde_test::assert_tokens(&Intents::GUILD_MESSAGE_REACTIONS, &[Token::U64(1 << 10)]);
serde_test::assert_tokens(&Intents::GUILD_MESSAGE_TYPING, &[Token::U64(1 << 11)]);
serde_test::assert_tokens(&Intents::DIRECT_MESSAGES, &[Token::U64(1 << 12)]);
serde_test::assert_tokens(&Intents::DIRECT_MESSAGE_REACTIONS, &[Token::U64(1 << 13)]);
serde_test::assert_tokens(&Intents::DIRECT_MESSAGE_TYPING, &[Token::U64(1 << 14)]);
}
}