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 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
//! 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]
//!
//! [Administrator]: Permissions::ADMINISTRATOR
//! [Ban Members]: Permissions::BAN_MEMBERS
//! [Kick Members]: Permissions::KICK_MEMBERS
//! [Manage Channels]: Permissions::MANAGE_CHANNELS
//! [Manage Guild]: Permissions::MANAGE_GUILD
//! [Manage Messages]: Permissions::MANAGE_MESSAGES
//! [Manage Roles]: Permissions::MANAGE_ROLES
//! [Manage Webhooks]: Permissions::MANAGE_WEBHOOKS
use std::fmt;
use serde::de::{Deserialize, Deserializer};
use serde::ser::{Serialize, Serializer};
/// This macro generates the [`Permissions::get_permission_names`] method.
///
/// It is invoked by passing the names of all methods used to check for
/// permissions along with their names displayed inside Discord.
///
/// ## Examples
///
/// Using this macro
///
/// ```ignore
/// generate_get_permission_names! {
/// add_reactions: "Add Reactions",
/// administrator: "Administrator"
/// };
/// ```
///
/// Generates this implementation:
///
/// ```ignore
/// impl Permissions {
/// fn get_permission_names(self) -> Vec<&'static str> {
/// let mut names = Vec::new();
///
/// if self.add_reactions() {
/// names.push("Add Reactions");
/// }
/// if self.administrator() {
/// names.push("Administrator");
/// }
///
/// names
/// }
/// }
/// ```
#[cfg(feature = "model")]
macro_rules! generate_get_permission_names {
{$ ($perm:ident: $name:expr),*} => {
impl Permissions {
/// Returns a list of names of all contained permissions.
#[must_use]
pub fn get_permission_names(self) -> Vec<&'static str> {
let mut names = Vec::new();
$(
if self.$perm() {
names.push($name);
}
)*
names
}
}
}
}
/// 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 Instant Invite]
/// - [Embed Links]
/// - [Mention Everyone]
/// - [Read Message History]
/// - [View Channel]
/// - [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
/// use serenity::model::permissions::{self, Permissions};
///
/// permissions::PRESET_GENERAL.toggle(Permissions::SEND_TTS_MESSAGES);
/// ```
///
/// [Add Reactions]: Permissions::ADD_REACTIONS
/// [Attach Files]: Permissions::ATTACH_FILES
/// [Change Nickname]: Permissions::CHANGE_NICKNAME
/// [Connect]: Permissions::CONNECT
/// [Create Instant Invite]: Permissions::CREATE_INSTANT_INVITE
/// [Embed Links]: Permissions::EMBED_LINKS
/// [Mention Everyone]: Permissions::MENTION_EVERYONE
/// [Read Message History]: Permissions::READ_MESSAGE_HISTORY
/// [View Channel]: Permissions::VIEW_CHANNEL
/// [Send Messages]: Permissions::SEND_MESSAGES
/// [Send TTS Messages]: Permissions::SEND_TTS_MESSAGES
/// [Speak]: Permissions::SPEAK
/// [Use External Emojis]: Permissions::USE_EXTERNAL_EMOJIS
/// [Use VAD]: Permissions::USE_VAD
pub const PRESET_GENERAL: Permissions = Permissions {
bits: Permissions::ADD_REACTIONS.bits
| Permissions::ATTACH_FILES.bits
| Permissions::CHANGE_NICKNAME.bits
| Permissions::CONNECT.bits
| Permissions::CREATE_INSTANT_INVITE.bits
| Permissions::EMBED_LINKS.bits
| Permissions::MENTION_EVERYONE.bits
| Permissions::READ_MESSAGE_HISTORY.bits
| Permissions::VIEW_CHANNEL.bits
| Permissions::SEND_MESSAGES.bits
| Permissions::SEND_TTS_MESSAGES.bits
| Permissions::SPEAK.bits
| Permissions::USE_EXTERNAL_EMOJIS.bits
| Permissions::USE_VAD.bits,
};
/// 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 Instant Invite]
/// - [Embed Links]
/// - [Mention Everyone]
/// - [Read Message History]
/// - [View Channel]
/// - [Send Messages]
/// - [Send TTS Messages]
/// - [Use External Emojis]
///
/// [Add Reactions]: Permissions::ADD_REACTIONS
/// [Attach Files]: Permissions::ATTACH_FILES
/// [Change Nickname]: Permissions::CHANGE_NICKNAME
/// [Create Instant Invite]: Permissions::CREATE_INSTANT_INVITE
/// [Embed Links]: Permissions::EMBED_LINKS
/// [Mention Everyone]: Permissions::MENTION_EVERYONE
/// [Read Message History]: Permissions::READ_MESSAGE_HISTORY
/// [View Channel]: Permissions::VIEW_CHANNEL
/// [Send Messages]: Permissions::SEND_MESSAGES
/// [Send TTS Messages]: Permissions::SEND_TTS_MESSAGES
/// [Use External Emojis]: Permissions::USE_EXTERNAL_EMOJIS
pub const PRESET_TEXT: Permissions = Permissions {
bits: Permissions::ADD_REACTIONS.bits
| Permissions::ATTACH_FILES.bits
| Permissions::CHANGE_NICKNAME.bits
| Permissions::CREATE_INSTANT_INVITE.bits
| Permissions::EMBED_LINKS.bits
| Permissions::MENTION_EVERYONE.bits
| Permissions::READ_MESSAGE_HISTORY.bits
| Permissions::VIEW_CHANNEL.bits
| Permissions::SEND_MESSAGES.bits
| Permissions::SEND_TTS_MESSAGES.bits
| Permissions::USE_EXTERNAL_EMOJIS.bits,
};
/// 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]
///
/// [Connect]: Permissions::CONNECT
/// [Speak]: Permissions::SPEAK
/// [Use VAD]: Permissions::USE_VAD
pub const PRESET_VOICE: Permissions = Permissions {
bits: Permissions::CONNECT.bits | Permissions::SPEAK.bits | Permissions::USE_VAD.bits,
};
bitflags::bitflags! {
/// 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`]: super::guild::Guild
/// [`GuildChannel`]: super::channel::GuildChannel
/// [`PermissionOverwrite`]: super::channel::PermissionOverwrite
/// [`Role`]: super::guild::Role
/// [`User`]: super::user::User
#[derive(Default)]
pub struct Permissions: u64 {
/// Allows for the creation of [`RichInvite`]s.
///
/// [`RichInvite`]: super::invite::RichInvite
const CREATE_INSTANT_INVITE = 1 << 0;
/// Allows for the kicking of guild [member]s.
///
/// [member]: super::guild::Member
const KICK_MEMBERS = 1 << 1;
/// Allows the banning of guild [member]s.
///
/// [member]: super::guild::Member
const BAN_MEMBERS = 1 << 2;
/// Allows all permissions, bypassing channel [permission overwrite]s.
///
/// [permission overwrite]: super::channel::PermissionOverwrite
const ADMINISTRATOR = 1 << 3;
/// Allows management and editing of guild [channel]s.
///
/// [channel]: super::channel::GuildChannel
const MANAGE_CHANNELS = 1 << 4;
/// Allows management and editing of the [guild].
///
/// [guild]: super::guild::Guild
const MANAGE_GUILD = 1 << 5;
/// [`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`]: super::guild::Member
/// [`Message`]: super::channel::Message
/// [`Reaction`]: super::channel::Reaction
const ADD_REACTIONS = 1 << 6;
/// Allows viewing a guild's audit logs.
const VIEW_AUDIT_LOG = 1 << 7;
/// Allows the use of priority speaking in voice channels.
const PRIORITY_SPEAKER = 1 << 8;
// Allows the user to go live.
const STREAM = 1 << 9;
/// Allows guild members to view a channel, which includes reading
/// messages in text channels and joining voice channels.
const VIEW_CHANNEL = 1 << 10;
/// Allows sending messages in a guild channel.
const SEND_MESSAGES = 1 << 11;
/// Allows the sending of text-to-speech messages in a channel.
const SEND_TTS_MESSAGES = 1 << 12;
/// Allows the deleting of other messages in a guild channel.
///
/// **Note**: This does not allow the editing of other messages.
const MANAGE_MESSAGES = 1 << 13;
/// Allows links from this user - or users of this role - to be
/// embedded, with potential data such as a thumbnail, description, and
/// page name.
const EMBED_LINKS = 1 << 14;
/// Allows uploading of files.
const ATTACH_FILES = 1 << 15;
/// Allows the reading of a channel's message history.
const READ_MESSAGE_HISTORY = 1 << 16;
/// 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.
const MENTION_EVERYONE = 1 << 17;
/// 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.
const USE_EXTERNAL_EMOJIS = 1 << 18;
/// Allows for viewing guild insights.
const VIEW_GUILD_INSIGHTS = 1 << 19;
/// Allows the joining of a voice channel.
const CONNECT = 1 << 20;
/// Allows the user to speak in a voice channel.
const SPEAK = 1 << 21;
/// Allows the muting of members in a voice channel.
const MUTE_MEMBERS = 1 << 22;
/// Allows the deafening of members in a voice channel.
const DEAFEN_MEMBERS = 1 << 23;
/// Allows the moving of members from one voice channel to another.
const MOVE_MEMBERS = 1 << 24;
/// Allows the usage of voice-activity-detection in a [voice] channel.
///
/// If this is disabled, then [`Member`]s must use push-to-talk.
///
/// [`Member`]: super::guild::Member
/// [voice]: super::channel::ChannelType::Voice
const USE_VAD = 1 << 25;
/// Allows members to change their own nickname in the guild.
const CHANGE_NICKNAME = 1 << 26;
/// Allows members to change other members' nicknames.
const MANAGE_NICKNAMES = 1 << 27;
/// Allows management and editing of roles below their own.
const MANAGE_ROLES = 1 << 28;
/// Allows management of webhooks.
const MANAGE_WEBHOOKS = 1 << 29;
/// Allows management of emojis and stickers created without the use of an
/// [`Integration`].
///
/// [`Integration`]: super::guild::Integration
const MANAGE_EMOJIS_AND_STICKERS = 1 << 30;
/// Allows using slash commands.
const USE_SLASH_COMMANDS = 1 << 31;
/// Allows for requesting to speak in stage channels.
const REQUEST_TO_SPEAK = 1 << 32;
/// Allows for creating, editing, and deleting scheduled events
const MANAGE_EVENTS = 1 << 33;
/// Allows for deleting and archiving threads, and viewing all private threads.
const MANAGE_THREADS = 1 << 34;
/// Allows for creating threads.
const CREATE_PUBLIC_THREADS = 1 << 35;
/// Allows for creating private threads.
const CREATE_PRIVATE_THREADS = 1 << 36;
/// Allows the usage of custom stickers from other servers.
const USE_EXTERNAL_STICKERS = 1 << 37;
/// Allows for sending messages in threads
const SEND_MESSAGES_IN_THREADS = 1 << 38;
/// Allows for launching activities in a voice channel
const USE_EMBEDDED_ACTIVITIES = 1 << 39;
/// Allows for timing out users to prevent them from sending or reacting to messages in
/// chat and threads, and from speaking in voice and stage channels.
const MODERATE_MEMBERS = 1 << 40;
}
}
#[cfg(feature = "model")]
generate_get_permission_names! {
add_reactions: "Add Reactions",
administrator: "Administrator",
attach_files: "Attach Files",
ban_members: "Ban Members",
change_nickname: "Change Nickname",
connect: "Connect",
create_instant_invite: "Create Instant Invite",
create_private_threads: "Create Private Threads",
create_public_threads: "Create Public Threads",
deafen_members: "Deafen Members",
embed_links: "Embed Links",
external_emojis: "Use External Emojis",
kick_members: "Kick Members",
manage_channels: "Manage Channels",
manage_emojis_and_stickers: "Manage Emojis and Stickers",
manage_events: "Manage Events",
manage_guild: "Manage Guilds",
manage_messages: "Manage Messages",
manage_nicknames: "Manage Nicknames",
manage_roles: "Manage Roles",
manage_threads: "Manage Threads",
manage_webhooks: "Manage Webhooks",
mention_everyone: "Mention Everyone",
moderate_members: "Moderate Members",
move_members: "Move Members",
mute_members: "Mute Members",
priority_speaker: "Priority Speaker",
read_message_history: "Read Message History",
request_to_speak: "Request To Speak",
send_messages: "Send Messages",
send_messages_in_threads: "Send Messages in Threads",
send_tts_messages: "Send TTS Messages",
speak: "Speak",
stream: "Stream",
use_embedded_activities: "Use Embedded Activities",
use_external_emojis: "Use External Emojis",
use_external_stickers: "Use External Stickers",
use_slash_commands: "Use Slash Commands",
use_vad: "Use Voice Activity",
view_audit_log: "View Audit Log",
view_channel: "View Channel",
view_guild_insights: "View Guild Insights"
}
#[cfg(feature = "model")]
impl Permissions {
/// Shorthand for checking that the set of permissions contains the
/// [Add Reactions] permission.
///
/// [Add Reactions]: Self::ADD_REACTIONS
#[must_use]
pub fn add_reactions(self) -> bool {
self.contains(Self::ADD_REACTIONS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Administrator] permission.
///
/// [Administrator]: Self::ADMINISTRATOR
#[must_use]
pub fn administrator(self) -> bool {
self.contains(Self::ADMINISTRATOR)
}
/// Shorthand for checking that the set of permissions contains the
/// [Attach Files] permission.
///
/// [Attach Files]: Self::ATTACH_FILES
#[must_use]
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]: Self::BAN_MEMBERS
#[must_use]
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]: Self::CHANGE_NICKNAME
#[must_use]
pub fn change_nickname(self) -> bool {
self.contains(Self::CHANGE_NICKNAME)
}
/// Shorthand for checking that the set of permissions contains the
/// [Connect] permission.
///
/// [Connect]: Self::CONNECT
#[must_use]
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]: Self::VIEW_AUDIT_LOG
#[must_use]
pub fn view_audit_log(self) -> bool {
self.contains(Self::VIEW_AUDIT_LOG)
}
/// Shorthand for checking that the set of permissions contains the
/// [View Channel] permission.
///
/// [View Channel]: Self::VIEW_CHANNEL
#[must_use]
pub fn view_channel(self) -> bool {
self.contains(Self::VIEW_CHANNEL)
}
/// Shorthand for checking that the set of permissions contains the
/// [View Guild Insights] permission.
///
/// [View Guild Insights]: Self::VIEW_GUILD_INSIGHTS
#[must_use]
pub fn view_guild_insights(self) -> bool {
self.contains(Self::VIEW_GUILD_INSIGHTS)
}
/// Shorthand for checking that the set of permission contains the
/// [Priority Speaker] permission.
///
/// [Priority Speaker]: Self::PRIORITY_SPEAKER
#[must_use]
pub fn priority_speaker(self) -> bool {
self.contains(Self::PRIORITY_SPEAKER)
}
/// Shorthand for checking that the set of permission contains the
/// [Stream] permission.
///
/// [Stream]: Self::STREAM
#[must_use]
pub fn stream(self) -> bool {
self.contains(Self::STREAM)
}
/// Shorthand for checking that the set of permissions contains the
/// [Create Instant Invite] permission.
///
/// [Create Instant Invite]: Self::CREATE_INSTANT_INVITE
#[must_use]
pub fn create_instant_invite(self) -> bool {
self.contains(Self::CREATE_INSTANT_INVITE)
}
/// Shorthand for checking that the set of permissions contains the
/// [Create Private Threads] permission.
///
/// [Create Private Threads]: Self::CREATE_PRIVATE_THREADS
#[must_use]
pub fn create_private_threads(self) -> bool {
self.contains(Self::CREATE_PRIVATE_THREADS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Create Public Threads] permission.
///
/// [Create Public Threads]: Self::CREATE_PUBLIC_THREADS
#[must_use]
pub fn create_public_threads(self) -> bool {
self.contains(Self::CREATE_PUBLIC_THREADS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Deafen Members] permission.
///
/// [Deafen Members]: Self::DEAFEN_MEMBERS
#[must_use]
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]: Self::EMBED_LINKS
#[must_use]
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]: Self::USE_EXTERNAL_EMOJIS
#[must_use]
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]: Self::KICK_MEMBERS
#[must_use]
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]: Self::MANAGE_CHANNELS
#[must_use]
pub fn manage_channels(self) -> bool {
self.contains(Self::MANAGE_CHANNELS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Manage Emojis and Stickers] permission.
///
/// [Manage Emojis and Stickers]: Self::MANAGE_EMOJIS_AND_STICKERS
#[must_use]
pub fn manage_emojis_and_stickers(self) -> bool {
self.contains(Self::MANAGE_EMOJIS_AND_STICKERS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Manage Events] permission.
///
/// [Manage Events]: Self::MANAGE_EVENTS
#[must_use]
pub fn manage_events(self) -> bool {
self.contains(Self::MANAGE_EVENTS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Manage Guild] permission.
///
/// [Manage Guild]: Self::MANAGE_GUILD
#[must_use]
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]: Self::MANAGE_MESSAGES
#[must_use]
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]: Self::MANAGE_NICKNAMES
#[must_use]
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]: Self::MANAGE_ROLES
#[must_use]
pub fn manage_roles(self) -> bool {
self.contains(Self::MANAGE_ROLES)
}
/// Shorthand for checking that the set of permissions contains the
/// [Manage Threads] permission.
///
/// [Manage Threads]: Self::MANAGE_THREADS
#[must_use]
pub fn manage_threads(self) -> bool {
self.contains(Self::MANAGE_THREADS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Manage Webhooks] permission.
///
/// [Manage Webhooks]: Self::MANAGE_WEBHOOKS
#[must_use]
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]: Self::MENTION_EVERYONE
#[must_use]
pub fn mention_everyone(self) -> bool {
self.contains(Self::MENTION_EVERYONE)
}
/// Shorthand for checking that the set of permissions contains the
/// [Moderate Members] permission.
///
/// [Moderate Members]: Self::MODERATE_MEMBERS
#[must_use]
pub fn moderate_members(self) -> bool {
self.contains(Self::MODERATE_MEMBERS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Move Members] permission.
///
/// [Move Members]: Self::MOVE_MEMBERS
#[must_use]
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]: Self::MUTE_MEMBERS
#[must_use]
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]: Self::READ_MESSAGE_HISTORY
#[must_use]
pub fn read_message_history(self) -> bool {
self.contains(Self::READ_MESSAGE_HISTORY)
}
/// Shorthand for checking that the set of permissions contains the
/// [Send Messages] permission.
///
/// [Send Messages]: Self::SEND_MESSAGES
#[must_use]
pub fn send_messages(self) -> bool {
self.contains(Self::SEND_MESSAGES)
}
/// Shorthand for checking that the set of permissions contains the
/// [Send Messages in Threads] permission.
///
/// [Send Messages in Threads]: Self::SEND_MESSAGES_IN_THREADS
#[must_use]
pub fn send_messages_in_threads(self) -> bool {
self.contains(Self::SEND_MESSAGES_IN_THREADS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Send TTS Messages] permission.
///
/// [Send TTS Messages]: Self::SEND_TTS_MESSAGES
#[must_use]
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]: Self::SPEAK
#[must_use]
pub fn speak(self) -> bool {
self.contains(Self::SPEAK)
}
/// Shorthand for checking that the set of permissions contains the
/// [Request To Speak] permission.
///
/// [Request To Speak]: Self::REQUEST_TO_SPEAK
#[must_use]
pub fn request_to_speak(self) -> bool {
self.contains(Self::REQUEST_TO_SPEAK)
}
/// Shorthand for checking that the set of permissions contains the
/// [Use Embedded Activities] permission.
///
/// [Use Embedded Activities]: Self::USE_EMBEDDED_ACTIVITIES
#[must_use]
pub fn use_embedded_activities(self) -> bool {
self.contains(Self::USE_EMBEDDED_ACTIVITIES)
}
/// Shorthand for checking that the set of permissions contains the
/// [Use External Emojis] permission.
///
/// [Use External Emojis]: Self::USE_EXTERNAL_EMOJIS
#[must_use]
pub fn use_external_emojis(self) -> bool {
self.contains(Self::USE_EXTERNAL_EMOJIS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Use External Stickers] permission.
///
/// [Use External Stickers]: Self::USE_EXTERNAL_STICKERS
#[must_use]
pub fn use_external_stickers(self) -> bool {
self.contains(Self::USE_EXTERNAL_STICKERS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Use Slash Commands] permission.
///
/// [Use Slash Commands]: Self::USE_SLASH_COMMANDS
#[must_use]
pub fn use_slash_commands(self) -> bool {
self.contains(Self::USE_SLASH_COMMANDS)
}
/// Shorthand for checking that the set of permissions contains the
/// [Use VAD] permission.
///
/// [Use VAD]: Self::USE_VAD
#[must_use]
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> {
struct StringVisitor;
impl<'de> serde::de::Visitor<'de> for StringVisitor {
type Value = Permissions;
fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
formatter.write_str("permissions string")
}
fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
let value = v.parse().map_err(E::custom)?;
Ok(Permissions::from_bits_truncate(value))
}
}
deserializer.deserialize_str(StringVisitor)
}
}
impl Serialize for Permissions {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.collect_str(&self.bits())
}
}
#[cfg(feature = "model")]
impl fmt::Display for Permissions {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let names = self.get_permission_names();
let total = names.len();
for (i, &name) in names.iter().enumerate() {
if i > 0 && i != total - 1 {
f.write_str(", ")?;
}
if total > 1 && i == total - 1 {
f.write_str(" and ")?;
}
f.write_str(name)?;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use serde_test::{assert_tokens, Token};
use super::*;
#[test]
fn permissions_serde() {
let value = Permissions::MANAGE_GUILD | Permissions::MANAGE_ROLES;
assert_tokens(&value, &[Token::Str("268435488")]);
}
}