twilight_model/guild/
permissions.rs

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        /// Allows for sending messages and creating forum threads, but not
23        /// sending messages in forum threads.
24        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        /// Allows management and editing of emojis, stickers, and soundboard sounds.
46        const MANAGE_GUILD_EXPRESSIONS = 1 << 30;
47        const USE_SLASH_COMMANDS = 1 << 31;
48        const REQUEST_TO_SPEAK = 1 << 32;
49        /// Allows for creating, editing, and deleting scheduled events.
50        const MANAGE_EVENTS = 1 << 33;
51        /// Allows for deleting and archiving threads, and viewing all private threads.
52        const MANAGE_THREADS = 1 << 34;
53        /// Allows for creating public threads.
54        const CREATE_PUBLIC_THREADS = 1 << 35;
55        /// Allows for creating private threads.
56        const CREATE_PRIVATE_THREADS = 1 << 36;
57        /// Allows the usage of custom stickers from other servers.
58        const USE_EXTERNAL_STICKERS = 1 << 37;
59        /// Allows for sending messages in threads.
60        const SEND_MESSAGES_IN_THREADS = 1 << 38;
61        /// Allows for using activities (applications with the `EMBEDDED`
62        /// flag) in a voice channel.
63        const USE_EMBEDDED_ACTIVITIES = 1 << 39;
64        /// Allows for timing out users to prevent them from sending or reacting
65        /// to messages in chat and threads, and from speaking in voice and
66        /// stage channels.
67        ///
68        /// See Discord's article on [Guild Timeouts].
69        ///
70        /// [Guild Timeouts]: https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ
71        const MODERATE_MEMBERS = 1 << 40;
72        /// Allows for viewing role subscription insights.
73        const VIEW_CREATOR_MONETIZATION_ANALYTICS = 1 << 41;
74        /// Allows for using soundboard in a voice channel
75        const USE_SOUNDBOARD = 1 << 42;
76        /// Allows for creating emojis, stickers, and soundboard sounds, and editing and
77        /// deleting those created by the current user.
78        const CREATE_GUILD_EXPRESSIONS = 1 << 43;
79        /// Allows for creating scheduled events, and editing and deleting those created
80        /// by the current user.
81        const CREATE_EVENTS = 1 << 44;
82        /// Allows the usage of custom soundboard sounds from other servers
83        const USE_EXTERNAL_SOUNDS = 1 << 45;
84        /// Allows sending voice messages
85        const SEND_VOICE_MESSAGES = 1 << 46;
86        /// Allows sending polls.
87        const SEND_POLLS = 1 << 49;
88        /// Allows user-installed apps to send public responses. When
89        /// disabled, users will still be allowed to use their apps
90        /// but the responses will be ephemeral. This only applies to
91        /// apps not also installed to the server.
92        const USE_EXTERNAL_APPS = 1 << 50;
93        /// Allows pinning and unpinning messages.
94        const PIN_MESSAGES = 1 << 51;
95        /// Allows to bypass slowmode in channels with slowmode enabled.
96        const BYPASS_SLOWMODE = 1 << 52;
97    }
98}
99
100struct PermissionsVisitor;
101
102impl Visitor<'_> for PermissionsVisitor {
103    type Value = Permissions;
104
105    fn expecting(&self, f: &mut Formatter<'_>) -> FmtResult {
106        f.write_str("integer or string permissions")
107    }
108
109    fn visit_u64<E: DeError>(self, v: u64) -> Result<Self::Value, E> {
110        Ok(Permissions::from_bits_truncate(v))
111    }
112
113    fn visit_str<E: DeError>(self, v: &str) -> Result<Self::Value, E> {
114        #[allow(clippy::map_err_ignore)]
115        let num = v
116            .parse()
117            .map_err(|_| DeError::custom("permissions is not valid bitflags"))?;
118
119        self.visit_u64(num)
120    }
121}
122
123impl<'de> Deserialize<'de> for Permissions {
124    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
125        deserializer.deserialize_any(PermissionsVisitor)
126    }
127}
128
129impl Serialize for Permissions {
130    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
131        serializer.serialize_str(&self.bits().to_string())
132    }
133}
134
135#[cfg(test)]
136mod tests {
137    use super::Permissions;
138    use serde::{Deserialize, Serialize};
139    use serde_test::Token;
140    use static_assertions::{assert_impl_all, const_assert_eq};
141    use std::{
142        fmt::{Binary, Debug, LowerHex, Octal, UpperHex},
143        hash::Hash,
144        ops::{
145            BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Not, Sub, SubAssign,
146        },
147    };
148
149    assert_impl_all!(
150        Permissions: Binary,
151        BitAnd,
152        BitAndAssign,
153        BitOr,
154        BitOrAssign,
155        BitXor,
156        BitXorAssign,
157        Clone,
158        Copy,
159        Debug,
160        Deserialize<'static>,
161        Eq,
162        Extend<Permissions>,
163        FromIterator<Permissions>,
164        Hash,
165        LowerHex,
166        Not,
167        Octal,
168        PartialEq,
169        Send,
170        Serialize,
171        Sub,
172        SubAssign,
173        Sync,
174        UpperHex
175    );
176    const_assert_eq!(Permissions::CREATE_INVITE.bits(), 1);
177    const_assert_eq!(Permissions::KICK_MEMBERS.bits(), 1 << 1);
178    const_assert_eq!(Permissions::BAN_MEMBERS.bits(), 1 << 2);
179    const_assert_eq!(Permissions::ADMINISTRATOR.bits(), 1 << 3);
180    const_assert_eq!(Permissions::MANAGE_CHANNELS.bits(), 1 << 4);
181    const_assert_eq!(Permissions::MANAGE_GUILD.bits(), 1 << 5);
182    const_assert_eq!(Permissions::ADD_REACTIONS.bits(), 1 << 6);
183    const_assert_eq!(Permissions::VIEW_AUDIT_LOG.bits(), 1 << 7);
184    const_assert_eq!(Permissions::PRIORITY_SPEAKER.bits(), 1 << 8);
185    const_assert_eq!(Permissions::STREAM.bits(), 1 << 9);
186    const_assert_eq!(Permissions::VIEW_CHANNEL.bits(), 1 << 10);
187    const_assert_eq!(Permissions::SEND_MESSAGES.bits(), 1 << 11);
188    const_assert_eq!(Permissions::SEND_TTS_MESSAGES.bits(), 1 << 12);
189    const_assert_eq!(Permissions::MANAGE_MESSAGES.bits(), 1 << 13);
190    const_assert_eq!(Permissions::EMBED_LINKS.bits(), 1 << 14);
191    const_assert_eq!(Permissions::ATTACH_FILES.bits(), 1 << 15);
192    const_assert_eq!(Permissions::READ_MESSAGE_HISTORY.bits(), 1 << 16);
193    const_assert_eq!(Permissions::MENTION_EVERYONE.bits(), 1 << 17);
194    const_assert_eq!(Permissions::USE_EXTERNAL_EMOJIS.bits(), 1 << 18);
195    const_assert_eq!(Permissions::VIEW_GUILD_INSIGHTS.bits(), 1 << 19);
196    const_assert_eq!(Permissions::CONNECT.bits(), 1 << 20);
197    const_assert_eq!(Permissions::SPEAK.bits(), 1 << 21);
198    const_assert_eq!(Permissions::MUTE_MEMBERS.bits(), 1 << 22);
199    const_assert_eq!(Permissions::DEAFEN_MEMBERS.bits(), 1 << 23);
200    const_assert_eq!(Permissions::MOVE_MEMBERS.bits(), 1 << 24);
201    const_assert_eq!(Permissions::USE_VAD.bits(), 1 << 25);
202    const_assert_eq!(Permissions::CHANGE_NICKNAME.bits(), 1 << 26);
203    const_assert_eq!(Permissions::MANAGE_NICKNAMES.bits(), 1 << 27);
204    const_assert_eq!(Permissions::MANAGE_ROLES.bits(), 1 << 28);
205    const_assert_eq!(Permissions::MANAGE_WEBHOOKS.bits(), 1 << 29);
206    const_assert_eq!(Permissions::MANAGE_GUILD_EXPRESSIONS.bits(), 1 << 30);
207    const_assert_eq!(Permissions::USE_SLASH_COMMANDS.bits(), 1 << 31);
208    const_assert_eq!(Permissions::REQUEST_TO_SPEAK.bits(), 1 << 32);
209    const_assert_eq!(Permissions::MANAGE_EVENTS.bits(), 1 << 33);
210    const_assert_eq!(Permissions::MANAGE_THREADS.bits(), 1 << 34);
211    const_assert_eq!(Permissions::CREATE_PUBLIC_THREADS.bits(), 1 << 35);
212    const_assert_eq!(Permissions::CREATE_PRIVATE_THREADS.bits(), 1 << 36);
213    const_assert_eq!(Permissions::USE_EXTERNAL_STICKERS.bits(), 1 << 37);
214    const_assert_eq!(Permissions::SEND_MESSAGES_IN_THREADS.bits(), 1 << 38);
215    const_assert_eq!(Permissions::USE_EMBEDDED_ACTIVITIES.bits(), 1 << 39);
216    const_assert_eq!(Permissions::MODERATE_MEMBERS.bits(), 1 << 40);
217    const_assert_eq!(
218        Permissions::VIEW_CREATOR_MONETIZATION_ANALYTICS.bits(),
219        1 << 41
220    );
221    const_assert_eq!(Permissions::USE_SOUNDBOARD.bits(), 1 << 42);
222    const_assert_eq!(Permissions::USE_EXTERNAL_SOUNDS.bits(), 1 << 45);
223    const_assert_eq!(Permissions::SEND_VOICE_MESSAGES.bits(), 1 << 46);
224    const_assert_eq!(Permissions::SEND_POLLS.bits(), 1 << 49);
225    const_assert_eq!(Permissions::USE_EXTERNAL_APPS.bits(), 1 << 50);
226    const_assert_eq!(Permissions::PIN_MESSAGES.bits(), 1 << 51);
227    const_assert_eq!(Permissions::BYPASS_SLOWMODE.bits(), 1 << 52);
228
229    #[test]
230    fn serde() {
231        serde_test::assert_tokens(&Permissions::CREATE_INVITE, &[Token::Str("1")]);
232        // Deserialization truncates unknown bits.
233        serde_test::assert_de_tokens(&Permissions::empty(), &[Token::Str("9223372036854775808")]);
234    }
235}
twilight_model/guild/permissions.rs

twilight_model/guild/
permissions.rs
