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

twilight_model/guild/
permissions.rs
