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 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
//! A set of permissions for a role or user. These can be assigned directly //! to a role or as a channel's permission overrides. //! //! For convenience, methods for each permission are available, which can be //! used to test if the set of permissions contains a single permission. //! This can simplify code and reduce a potential import. //! //! Additionally, presets equivalent to the official client's `@everyone` role //! presets are available. These are [`PRESET_GENERAL`], [`PRESET_TEXT`], and //! [`PRESET_VOICE`]. //! //! Permissions follow a hierarchy: //! //! - An account can grant roles to users that are of a lower position than //! its highest role; //! - An account can edit roles lesser than its highest role, but can only //! grant permissions they have; //! - An account can move only roles lesser than its highest role; //! - An account can only kick/ban accounts with a lesser role than its top //! role. //! //! **Note**: The following permissions require the owner account (e.g. the //! owner of a bot) to use two-factor authentication in the case that a guild //! has guild-wide 2FA enabled: //! //! - [Administrator] //! - [Ban Members] //! - [Kick Members] //! - [Manage Channels] //! - [Manage Guild] //! - [Manage Messages] //! - [Manage Roles] //! - [Manage Webhooks] //! //! [`PRESET_GENERAL`]: constant.PRESET_GENERAL.html //! [`PRESET_TEXT`]: constant.PRESET_TEXT.html //! [`PRESET_VOICE`]: constant.PRESET_VOICE.html //! [Administrator]: struct.Permissions.html#associatedconstant.ADMINISTRATOR //! [Ban Members]: struct.Permissions.html#associatedconstant.BAN_MEMBERS //! [Kick Members]: struct.Permissions.html#associatedconstant.KICK_MEMBERS //! [Manage Channels]: struct.Permissions.html#associatedconstant.MANAGE_CHANNELS //! [Manage Guild]: struct.Permissions.html#associatedconstant.MANAGE_GUILD //! [Manage Messages]: struct.Permissions.html#associatedconstant.MANAGE_MESSAGES //! [Manage Roles]: struct.Permissions.html#associatedconstant.MANAGE_ROLES //! [Manage Webhooks]: struct.Permissions.html#associatedconstant.MANAGE_WEBHOOKS use serde::de::{Deserialize, Deserializer}; use serde::ser::{Serialize, Serializer}; use super::utils::U64Visitor; use bitflags::__impl_bitflags; /// Returns a set of permissions with the original @everyone permissions set /// to true. /// /// This includes the following permissions: /// /// - [Add Reactions] /// - [Attach Files] /// - [Change Nickname] /// - [Connect] /// - [Create Invite] /// - [Embed Links] /// - [Mention Everyone] /// - [Read Message History] /// - [Read Messages] /// - [Send Messages] /// - [Send TTS Messages] /// - [Speak] /// - [Use External Emojis] /// - [Use VAD] /// /// **Note**: The [Send TTS Messages] permission is set to `true`. Consider /// setting this to `false`, via: /// /// ```rust,ignore /// use serenity::model::permissions; /// /// permissions::general().toggle(permissions::SEND_TTS_MESSAGES); /// ``` /// /// [Add Reactions]: struct.Permissions.html#associatedconstant.ADD_REACTIONS /// [Attach Files]: struct.Permissions.html#associatedconstant.ATTACH_FILES /// [Change Nickname]: struct.Permissions.html#associatedconstant.CHANGE_NICKNAME /// [Connect]: struct.Permissions.html#associatedconstant.CONNECT /// [Create Invite]: struct.Permissions.html#associatedconstant.CREATE_INVITE /// [Embed Links]: struct.Permissions.html#associatedconstant.EMBED_LINKS /// [Mention Everyone]: struct.Permissions.html#associatedconstant.MENTION_EVERYONE /// [Read Message History]: struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY /// [Read Messages]: struct.Permissions.html#associatedconstant.READ_MESSAGES /// [Send Messages]: struct.Permissions.html#associatedconstant.SEND_MESSAGES /// [Send TTS Messages]: struct.Permissions.html#associatedconstant.SEND_TTS_MESSAGES /// [Speak]: struct.Permissions.html#associatedconstant.SPEAK /// [Use External Emojis]: struct.Permissions.html#associatedconstant.USE_EXTERNAL_EMOJIS /// [Use VAD]: struct.Permissions.html#associatedconstant.USE_VAD pub const PRESET_GENERAL: Permissions = Permissions { bits: 0b0000_0110_0011_0111_1101_1100_0100_0001, }; /// Returns a set of text-only permissions with the original `@everyone` /// permissions set to true. /// /// This includes the text permissions that are in [`PRESET_GENERAL`]: /// /// - [Add Reactions] /// - [Attach Files] /// - [Change Nickname] /// - [Create Invite] /// - [Embed Links] /// - [Mention Everyone] /// - [Read Message History] /// - [Read Messages] /// - [Send Messages] /// - [Send TTS Messages] /// - [Use External Emojis] /// /// [`PRESET_GENERAL`]: constant.PRESET_GENERAL.html /// [Add Reactions]: struct.Permissions.html#associatedconstant.ADD_REACTIONS /// [Attach Files]: struct.Permissions.html#associatedconstant.ATTACH_FILES /// [Change Nickname]: struct.Permissions.html#associatedconstant.CHANGE_NICKNAME /// [Create Invite]: struct.Permissions.html#associatedconstant.CREATE_INVITE /// [Embed Links]: struct.Permissions.html#associatedconstant.EMBED_LINKS /// [Mention Everyone]: struct.Permissions.html#associatedconstant.MENTION_EVERYONE /// [Read Message History]: struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY /// [Read Messages]: struct.Permissions.html#associatedconstant.READ_MESSAGES /// [Send Messages]: struct.Permissions.html#associatedconstant.SEND_MESSAGES /// [Send TTS Messages]: struct.Permissions.html#associatedconstant.SEND_TTS_MESSAGES /// [Use External Emojis]: struct.Permissions.html#associatedconstant.USE_EXTERNAL_EMOJIS pub const PRESET_TEXT: Permissions = Permissions { bits: 0b0000_0000_0000_0111_1111_1100_0100_0000, }; /// Returns a set of voice-only permissions with the original `@everyone` /// permissions set to true. /// /// This includes the voice permissions that are in [`PRESET_GENERAL`]: /// /// - [Connect] /// - [Speak] /// - [Use VAD] /// /// [`PRESET_GENERAL`]: constant.PRESET_GENERAL.html /// [Connect]: struct.Permissions.html#associatedconstant.CONNECT /// [Speak]: struct.Permissions.html#associatedconstant.SPEAK /// [Use VAD]: struct.Permissions.html#associatedconstant.USE_VAD pub const PRESET_VOICE: Permissions = Permissions { bits: 0b0000_0011_1111_0000_0000_0000_0000_0000, }; /// A set of permissions that can be assigned to [`User`]s and [`Role`]s via /// [`PermissionOverwrite`]s, roles globally in a [`Guild`], and to /// [`GuildChannel`]s. /// /// [`Guild`]: ../guild/struct.Guild.html /// [`GuildChannel`]: ../channel/struct.GuildChannel.html /// [`PermissionOverwrite`]: ../channel/struct.PermissionOverwrite.html /// [`Role`]: ../guild/struct.Role.html /// [`User`]: ../user/struct.User.html /// #[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord, Hash)] pub struct Permissions { /// The flags making up the permissions. /// /// # Note /// Do not modify this yourself; use the provided methods. /// Do the same when creating, unless you're absolutely certain that you're giving valid permission flags. pub bits: u64 } __impl_bitflags! { Permissions: u64 { /// Allows for the creation of [`RichInvite`]s. /// /// [`RichInvite`]: ../invite/struct.RichInvite.html CREATE_INVITE = 0b0000_0000_0000_0000_0000_0000_0000_0001; /// Allows for the kicking of guild [member]s. /// /// [member]: ../guild/struct.Member.html KICK_MEMBERS = 0b0000_0000_0000_0000_0000_0000_0000_0010; /// Allows the banning of guild [member]s. /// /// [member]: ../guild/struct.Member.html BAN_MEMBERS = 0b0000_0000_0000_0000_0000_0000_0000_0100; /// Allows all permissions, bypassing channel [permission overwrite]s. /// /// [permission overwrite]: ../channel/struct.PermissionOverwrite.html ADMINISTRATOR = 0b0000_0000_0000_0000_0000_0000_0000_1000; /// Allows management and editing of guild [channel]s. /// /// [channel]: ../channel/struct.GuildChannel.html MANAGE_CHANNELS = 0b0000_0000_0000_0000_0000_0000_0001_0000; /// Allows management and editing of the [guild]. /// /// [guild]: ../guild/struct.Guild.html MANAGE_GUILD = 0b0000_0000_0000_0000_0000_0000_0010_0000; /// [`Member`]s with this permission can add new [`Reaction`]s to a /// [`Message`]. Members can still react using reactions already added /// to messages without this permission. /// /// [`Member`]: ../guild/struct.Member.html /// [`Message`]: ../channel/struct.Message.html /// [`Reaction`]: ../channel/struct.Reaction.html ADD_REACTIONS = 0b0000_0000_0000_0000_0000_0000_0100_0000; /// Allows viewing a guild's audit logs. VIEW_AUDIT_LOG = 0b0000_0000_0000_0000_0000_0000_1000_0000; /// Allows the use of priority speaking in voice channels. PRIORITY_SPEAKER = 0b0000_0000_0000_0000_0000_0001_0000_0000; /// Allows reading messages in a guild channel. If a user does not have /// this permission, then they will not be able to see the channel. READ_MESSAGES = 0b0000_0000_0000_0000_0000_0100_0000_0000; /// Allows sending messages in a guild channel. SEND_MESSAGES = 0b0000_0000_0000_0000_0000_1000_0000_0000; /// Allows the sending of text-to-speech messages in a channel. SEND_TTS_MESSAGES = 0b0000_0000_0000_0000_0001_0000_0000_0000; /// Allows the deleting of other messages in a guild channel. /// /// **Note**: This does not allow the editing of other messages. MANAGE_MESSAGES = 0b0000_0000_0000_0000_0010_0000_0000_0000; /// Allows links from this user - or users of this role - to be /// embedded, with potential data such as a thumbnail, description, and /// page name. EMBED_LINKS = 0b0000_0000_0000_0000_0100_0000_0000_0000; /// Allows uploading of files. ATTACH_FILES = 0b0000_0000_0000_0000_1000_0000_0000_0000; /// Allows the reading of a channel's message history. READ_MESSAGE_HISTORY = 0b0000_0000_0000_0001_0000_0000_0000_0000; /// Allows the usage of the `@everyone` mention, which will notify all /// users in a channel. The `@here` mention will also be available, and /// can be used to mention all non-offline users. /// /// **Note**: You probably want this to be disabled for most roles and /// users. MENTION_EVERYONE = 0b0000_0000_0000_0010_0000_0000_0000_0000; /// Allows the usage of custom emojis from other guilds. /// /// This does not dictate whether custom emojis in this guild can be /// used in other guilds. USE_EXTERNAL_EMOJIS = 0b0000_0000_0000_0100_0000_0000_0000_0000; /// Allows the joining of a voice channel. CONNECT = 0b0000_0000_0001_0000_0000_0000_0000_0000; /// Allows the user to speak in a voice channel. SPEAK = 0b0000_0000_0010_0000_0000_0000_0000_0000; /// Allows the muting of members in a voice channel. MUTE_MEMBERS = 0b0000_0000_0100_0000_0000_0000_0000_0000; /// Allows the deafening of members in a voice channel. DEAFEN_MEMBERS = 0b0000_0000_1000_0000_0000_0000_0000_0000; /// Allows the moving of members from one voice channel to another. MOVE_MEMBERS = 0b0000_0001_0000_0000_0000_0000_0000_0000; /// Allows the usage of voice-activity-detection in a [voice] channel. /// /// If this is disabled, then [`Member`]s must use push-to-talk. /// /// [`Member`]: ../guild/struct.Member.html /// [voice]: ../channel/enum.ChannelType.html#variant.Voice USE_VAD = 0b0000_0010_0000_0000_0000_0000_0000_0000; /// Allows members to change their own nickname in the guild. CHANGE_NICKNAME = 0b0000_0100_0000_0000_0000_0000_0000_0000; /// Allows members to change other members' nicknames. MANAGE_NICKNAMES = 0b0000_1000_0000_0000_0000_0000_0000_0000; /// Allows management and editing of roles below their own. MANAGE_ROLES = 0b0001_0000_0000_0000_0000_0000_0000_0000; /// Allows management of webhooks. MANAGE_WEBHOOKS = 0b0010_0000_0000_0000_0000_0000_0000_0000; /// Allows management of emojis created without the use of an /// [`Integration`]. /// /// [`Integration`]: ../guild/struct.Integration.html MANAGE_EMOJIS = 0b0100_0000_0000_0000_0000_0000_0000_0000; } } #[cfg(feature = "model")] impl Permissions { /// Shorthand for checking that the set of permissions contains the /// [Add Reactions] permission. /// /// [Add Reactions]: #associatedconstant.ADD_REACTIONS pub fn add_reactions(self) -> bool { self.contains(Self::ADD_REACTIONS) } /// Shorthand for checking that the set of permissions contains the /// [Administrator] permission. /// /// [Administrator]: #associatedconstant.ADMINISTRATOR pub fn administrator(self) -> bool { self.contains(Self::ADMINISTRATOR) } /// Shorthand for checking that the set of permissions contains the /// [Attach Files] permission. /// /// [Attach Files]: #associatedconstant.ATTACH_FILES pub fn attach_files(self) -> bool { self.contains(Self::ATTACH_FILES) } /// Shorthand for checking that the set of permissions contains the /// [Ban Members] permission. /// /// [Ban Members]: #associatedconstant.BAN_MEMBERS pub fn ban_members(self) -> bool { self.contains(Self::BAN_MEMBERS) } /// Shorthand for checking that the set of permissions contains the /// [Change Nickname] permission. /// /// [Change Nickname]: #associatedconstant.CHANGE_NICKNAME pub fn change_nickname(self) -> bool { self.contains(Self::CHANGE_NICKNAME) } /// Shorthand for checking that the set of permissions contains the /// [Connect] permission. /// /// [Connect]: #associatedconstant.CONNECT pub fn connect(self) -> bool { self.contains(Self::CONNECT) } /// Shorthand for checking that the set of permissions contains the /// [View Audit Log] permission. /// /// [View Audit Log]: #associatedconstant.VIEW_AUDIT_LOG pub fn view_audit_log(self) -> bool { self.contains(Self::VIEW_AUDIT_LOG) } /// Shorthand for checking that the set of permission contains the /// [Priority Speaker] permission. /// /// [Priority Speaker]: #associatedconstant.PRIORITY_SPEAKER pub fn priority_speaker(self) -> bool { self.contains(Self::PRIORITY_SPEAKER) } /// Shorthand for checking that the set of permissions contains the /// [Create Invite] permission. /// /// [Create Invite]: #associatedconstant.CREATE_INVITE pub fn create_invite(self) -> bool { self.contains(Self::CREATE_INVITE) } /// Shorthand for checking that the set of permissions contains the /// [Deafen Members] permission. /// /// [Deafen Members]: #associatedconstant.DEAFEN_MEMBERS pub fn deafen_members(self) -> bool { self.contains(Self::DEAFEN_MEMBERS) } /// Shorthand for checking that the set of permissions contains the /// [Embed Links] permission. /// /// [Embed Links]: #associatedconstant.EMBED_LINKS pub fn embed_links(self) -> bool { self.contains(Self::EMBED_LINKS) } /// Shorthand for checking that the set of permissions contains the /// [Use External Emojis] permission. /// /// [Use External Emojis]: #associatedconstant.USE_EXTERNAL_EMOJIS pub fn external_emojis(self) -> bool { self.contains(Self::USE_EXTERNAL_EMOJIS) } /// Shorthand for checking that the set of permissions contains the /// [Kick Members] permission. /// /// [Kick Members]: #associatedconstant.KICK_MEMBERS pub fn kick_members(self) -> bool { self.contains(Self::KICK_MEMBERS) } /// Shorthand for checking that the set of permissions contains the /// [Manage Channels] permission. /// /// [Manage Channels]: #associatedconstant.MANAGE_CHANNELS pub fn manage_channels(self) -> bool { self.contains(Self::MANAGE_CHANNELS) } /// Shorthand for checking that the set of permissions contains the /// [Manage Emojis] permission. /// /// [Manage Emojis]: #associatedconstant.MANAGE_EMOJIS pub fn manage_emojis(self) -> bool { self.contains(Self::MANAGE_EMOJIS) } /// Shorthand for checking that the set of permissions contains the /// [Manage Guild] permission. /// /// [Manage Guild]: #associatedconstant.MANAGE_GUILD pub fn manage_guild(self) -> bool { self.contains(Self::MANAGE_GUILD) } /// Shorthand for checking that the set of permissions contains the /// [Manage Messages] permission. /// /// [Manage Messages]: #associatedconstant.MANAGE_MESSAGES pub fn manage_messages(self) -> bool { self.contains(Self::MANAGE_MESSAGES) } /// Shorthand for checking that the set of permissions contains the /// [Manage Nicknames] permission. /// /// [Manage Nicknames]: #associatedconstant.MANAGE_NICKNAMES pub fn manage_nicknames(self) -> bool { self.contains(Self::MANAGE_NICKNAMES) } /// Shorthand for checking that the set of permissions contains the /// [Manage Roles] permission. /// /// [Manage Roles]: #associatedconstant.MANAGE_ROLES pub fn manage_roles(self) -> bool { self.contains(Self::MANAGE_ROLES) } /// Shorthand for checking that the set of permissions contains the /// [Manage Webhooks] permission. /// /// [Manage Webhooks]: #associatedconstant.MANAGE_WEBHOOKS pub fn manage_webhooks(self) -> bool { self.contains(Self::MANAGE_WEBHOOKS) } /// Shorthand for checking that the set of permissions contains the /// [Mention Everyone] permission. /// /// [Mention Everyone]: #associatedconstant.MENTION_EVERYONE pub fn mention_everyone(self) -> bool { self.contains(Self::MENTION_EVERYONE) } /// Shorthand for checking that the set of permissions contains the /// [Move Members] permission. /// /// [Move Members]: #associatedconstant.MOVE_MEMBERS pub fn move_members(self) -> bool { self.contains(Self::MOVE_MEMBERS) } /// Shorthand for checking that the set of permissions contains the /// [Mute Members] permission. /// /// [Mute Members]: #associatedconstant.MUTE_MEMBERS pub fn mute_members(self) -> bool { self.contains(Self::MUTE_MEMBERS) } /// Shorthand for checking that the set of permissions contains the /// [Read Message History] permission. /// /// [Read Message History]: #associatedconstant.READ_MESSAGE_HISTORY pub fn read_message_history(self) -> bool { self.contains(Self::READ_MESSAGE_HISTORY) } /// Shorthand for checking that the set of permissions contains the /// [Read Messages] permission. /// /// [Read Messages]: #associatedconstant.READ_MESSAGES pub fn read_messages(self) -> bool { self.contains(Self::READ_MESSAGES) } /// Shorthand for checking that the set of permissions contains the /// [Send Messages] permission. /// /// [Send Messages]: #associatedconstant.SEND_MESSAGES pub fn send_messages(self) -> bool { self.contains(Self::SEND_MESSAGES) } /// Shorthand for checking that the set of permissions contains the /// [Send TTS Messages] permission. /// /// [Send TTS Messages]: #associatedconstant.SEND_TTS_MESSAGES pub fn send_tts_messages(self) -> bool { self.contains(Self::SEND_TTS_MESSAGES) } /// Shorthand for checking that the set of permissions contains the /// [Speak] permission. /// /// [Speak]: #associatedconstant.SPEAK pub fn speak(self) -> bool { self.contains(Self::SPEAK) } /// Shorthand for checking that the set of permissions contains the /// [Use External Emojis] permission. /// /// [Use External Emojis]: #associatedconstant.USE_EXTERNAL_EMOJIS pub fn use_external_emojis(self) -> bool { self.contains(Self::USE_EXTERNAL_EMOJIS) } /// Shorthand for checking that the set of permissions contains the /// [Use VAD] permission. /// /// [Use VAD]: #associatedconstant.USE_VAD pub fn use_vad(self) -> bool { self.contains(Self::USE_VAD) } } impl<'de> Deserialize<'de> for Permissions { fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> { Ok(Permissions::from_bits_truncate( deserializer.deserialize_u64(U64Visitor)?, )) } } impl Serialize for Permissions { fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer { serializer.serialize_u64(self.bits()) } }