1use bitflags::bitflags;
2use serde::{
3 de::{Deserialize, Deserializer, Error as DeError, Visitor},
4 ser::{Serialize, Serializer},
5};
6use std::fmt::{Formatter, Result as FmtResult};
7
8bitflags! {
9 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
10 pub struct Permissions: u64 {
11 const CREATE_INVITE = 1;
12 const KICK_MEMBERS = 1 << 1;
13 const BAN_MEMBERS = 1 << 2;
14 const ADMINISTRATOR = 1 << 3;
15 const MANAGE_CHANNELS = 1 << 4;
16 const MANAGE_GUILD = 1 << 5;
17 const ADD_REACTIONS = 1 << 6;
18 const VIEW_AUDIT_LOG = 1 << 7;
19 const PRIORITY_SPEAKER = 1 << 8;
20 const STREAM = 1 << 9;
21 const VIEW_CHANNEL = 1 << 10;
22 const SEND_MESSAGES = 1 << 11;
25 const SEND_TTS_MESSAGES = 1 << 12;
26 const MANAGE_MESSAGES = 1 << 13;
27 const EMBED_LINKS = 1 << 14;
28 const ATTACH_FILES = 1 << 15;
29 const READ_MESSAGE_HISTORY = 1 << 16;
30 const MENTION_EVERYONE = 1 << 17;
31 const USE_EXTERNAL_EMOJIS = 1 << 18;
32 const VIEW_GUILD_INSIGHTS = 1 << 19;
33 const CONNECT = 1 << 20;
34 const SPEAK = 1 << 21;
35 const MUTE_MEMBERS = 1 << 22;
36 const DEAFEN_MEMBERS = 1 << 23;
37 const MOVE_MEMBERS = 1 << 24;
38 const USE_VAD = 1 << 25;
39 const CHANGE_NICKNAME = 1 << 26;
40 const MANAGE_NICKNAMES = 1 << 27;
41 const MANAGE_ROLES = 1 << 28;
42 const MANAGE_WEBHOOKS = 1 << 29;
43 #[deprecated(since = "0.15.2", note = "use `MANAGE_GUILD_EXPRESSIONS` instead")]
44 const MANAGE_EMOJIS_AND_STICKERS = 1 << 30;
45 const MANAGE_GUILD_EXPRESSIONS = 1 << 30;
47 const USE_SLASH_COMMANDS = 1 << 31;
48 const REQUEST_TO_SPEAK = 1 << 32;
49 const MANAGE_EVENTS = 1 << 33;
51 const MANAGE_THREADS = 1 << 34;
53 const CREATE_PUBLIC_THREADS = 1 << 35;
55 const CREATE_PRIVATE_THREADS = 1 << 36;
57 const USE_EXTERNAL_STICKERS = 1 << 37;
59 const SEND_MESSAGES_IN_THREADS = 1 << 38;
61 const USE_EMBEDDED_ACTIVITIES = 1 << 39;
64 const MODERATE_MEMBERS = 1 << 40;
72 const VIEW_CREATOR_MONETIZATION_ANALYTICS = 1 << 41;
74 const USE_SOUNDBOARD = 1 << 42;
76 const USE_EXTERNAL_SOUNDS = 1 << 45;
78 const SEND_VOICE_MESSAGES = 1 << 46;
80 const SEND_POLLS = 1 << 49;
82 const USE_EXTERNAL_APPS = 1 << 50;
87 const PIN_MESSAGES = 1 << 51;
89 }
90}
91
92struct PermissionsVisitor;
93
94impl Visitor<'_> for PermissionsVisitor {
95 type Value = Permissions;
96
97 fn expecting(&self, f: &mut Formatter<'_>) -> FmtResult {
98 f.write_str("integer or string permissions")
99 }
100
101 fn visit_u64<E: DeError>(self, v: u64) -> Result<Self::Value, E> {
102 Ok(Permissions::from_bits_truncate(v))
103 }
104
105 fn visit_str<E: DeError>(self, v: &str) -> Result<Self::Value, E> {
106 #[allow(clippy::map_err_ignore)]
107 let num = v
108 .parse()
109 .map_err(|_| DeError::custom("permissions is not valid bitflags"))?;
110
111 self.visit_u64(num)
112 }
113}
114
115impl<'de> Deserialize<'de> for Permissions {
116 fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
117 deserializer.deserialize_any(PermissionsVisitor)
118 }
119}
120
121impl Serialize for Permissions {
122 fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
123 serializer.serialize_str(&self.bits().to_string())
124 }
125}
126
127#[cfg(test)]
128mod tests {
129 use super::Permissions;
130 use serde::{Deserialize, Serialize};
131 use serde_test::Token;
132 use static_assertions::{assert_impl_all, const_assert_eq};
133 use std::{
134 fmt::{Binary, Debug, LowerHex, Octal, UpperHex},
135 hash::Hash,
136 ops::{
137 BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Not, Sub, SubAssign,
138 },
139 };
140
141 assert_impl_all!(
142 Permissions: Binary,
143 BitAnd,
144 BitAndAssign,
145 BitOr,
146 BitOrAssign,
147 BitXor,
148 BitXorAssign,
149 Clone,
150 Copy,
151 Debug,
152 Deserialize<'static>,
153 Eq,
154 Extend<Permissions>,
155 FromIterator<Permissions>,
156 Hash,
157 LowerHex,
158 Not,
159 Octal,
160 PartialEq,
161 Send,
162 Serialize,
163 Sub,
164 SubAssign,
165 Sync,
166 UpperHex
167 );
168 const_assert_eq!(Permissions::CREATE_INVITE.bits(), 1);
169 const_assert_eq!(Permissions::KICK_MEMBERS.bits(), 1 << 1);
170 const_assert_eq!(Permissions::BAN_MEMBERS.bits(), 1 << 2);
171 const_assert_eq!(Permissions::ADMINISTRATOR.bits(), 1 << 3);
172 const_assert_eq!(Permissions::MANAGE_CHANNELS.bits(), 1 << 4);
173 const_assert_eq!(Permissions::MANAGE_GUILD.bits(), 1 << 5);
174 const_assert_eq!(Permissions::ADD_REACTIONS.bits(), 1 << 6);
175 const_assert_eq!(Permissions::VIEW_AUDIT_LOG.bits(), 1 << 7);
176 const_assert_eq!(Permissions::PRIORITY_SPEAKER.bits(), 1 << 8);
177 const_assert_eq!(Permissions::STREAM.bits(), 1 << 9);
178 const_assert_eq!(Permissions::VIEW_CHANNEL.bits(), 1 << 10);
179 const_assert_eq!(Permissions::SEND_MESSAGES.bits(), 1 << 11);
180 const_assert_eq!(Permissions::SEND_TTS_MESSAGES.bits(), 1 << 12);
181 const_assert_eq!(Permissions::MANAGE_MESSAGES.bits(), 1 << 13);
182 const_assert_eq!(Permissions::EMBED_LINKS.bits(), 1 << 14);
183 const_assert_eq!(Permissions::ATTACH_FILES.bits(), 1 << 15);
184 const_assert_eq!(Permissions::READ_MESSAGE_HISTORY.bits(), 1 << 16);
185 const_assert_eq!(Permissions::MENTION_EVERYONE.bits(), 1 << 17);
186 const_assert_eq!(Permissions::USE_EXTERNAL_EMOJIS.bits(), 1 << 18);
187 const_assert_eq!(Permissions::VIEW_GUILD_INSIGHTS.bits(), 1 << 19);
188 const_assert_eq!(Permissions::CONNECT.bits(), 1 << 20);
189 const_assert_eq!(Permissions::SPEAK.bits(), 1 << 21);
190 const_assert_eq!(Permissions::MUTE_MEMBERS.bits(), 1 << 22);
191 const_assert_eq!(Permissions::DEAFEN_MEMBERS.bits(), 1 << 23);
192 const_assert_eq!(Permissions::MOVE_MEMBERS.bits(), 1 << 24);
193 const_assert_eq!(Permissions::USE_VAD.bits(), 1 << 25);
194 const_assert_eq!(Permissions::CHANGE_NICKNAME.bits(), 1 << 26);
195 const_assert_eq!(Permissions::MANAGE_NICKNAMES.bits(), 1 << 27);
196 const_assert_eq!(Permissions::MANAGE_ROLES.bits(), 1 << 28);
197 const_assert_eq!(Permissions::MANAGE_WEBHOOKS.bits(), 1 << 29);
198 const_assert_eq!(Permissions::MANAGE_GUILD_EXPRESSIONS.bits(), 1 << 30);
199 const_assert_eq!(Permissions::USE_SLASH_COMMANDS.bits(), 1 << 31);
200 const_assert_eq!(Permissions::REQUEST_TO_SPEAK.bits(), 1 << 32);
201 const_assert_eq!(Permissions::MANAGE_EVENTS.bits(), 1 << 33);
202 const_assert_eq!(Permissions::MANAGE_THREADS.bits(), 1 << 34);
203 const_assert_eq!(Permissions::CREATE_PUBLIC_THREADS.bits(), 1 << 35);
204 const_assert_eq!(Permissions::CREATE_PRIVATE_THREADS.bits(), 1 << 36);
205 const_assert_eq!(Permissions::USE_EXTERNAL_STICKERS.bits(), 1 << 37);
206 const_assert_eq!(Permissions::SEND_MESSAGES_IN_THREADS.bits(), 1 << 38);
207 const_assert_eq!(Permissions::USE_EMBEDDED_ACTIVITIES.bits(), 1 << 39);
208 const_assert_eq!(Permissions::MODERATE_MEMBERS.bits(), 1 << 40);
209 const_assert_eq!(
210 Permissions::VIEW_CREATOR_MONETIZATION_ANALYTICS.bits(),
211 1 << 41
212 );
213 const_assert_eq!(Permissions::USE_SOUNDBOARD.bits(), 1 << 42);
214 const_assert_eq!(Permissions::USE_EXTERNAL_SOUNDS.bits(), 1 << 45);
215 const_assert_eq!(Permissions::SEND_VOICE_MESSAGES.bits(), 1 << 46);
216 const_assert_eq!(Permissions::SEND_POLLS.bits(), 1 << 49);
217 const_assert_eq!(Permissions::USE_EXTERNAL_APPS.bits(), 1 << 50);
218 const_assert_eq!(Permissions::PIN_MESSAGES.bits(), 1 << 51);
219
220 #[test]
221 fn serde() {
222 serde_test::assert_tokens(&Permissions::CREATE_INVITE, &[Token::Str("1")]);
223 serde_test::assert_de_tokens(&Permissions::empty(), &[Token::Str("9223372036854775808")]);
225 }
226}