Struct Permissions

#[repr(packed(1))]
pub struct Permissions(/* private fields */);

A set of permissions that can be assigned to Users and Roles via PermissionOverwrites, roles globally in a Guild, and to GuildChannels.

Discord docs.

Implementations

impl Permissions

pub const CREATE_INSTANT_INVITE: Self

Allows for the creation of RichInvites.

pub const KICK_MEMBERS: Self

Allows for the kicking of guild members.

pub const BAN_MEMBERS: Self

Allows the banning of guild members.

pub const ADMINISTRATOR: Self

Allows all permissions, bypassing channel permission overwrites.

pub const MANAGE_CHANNELS: Self

Allows management and editing of guild channels.

pub const MANAGE_GUILD: Self

Allows management and editing of the guild.

pub const ADD_REACTIONS: Self

Members with this permission can add new Reactions to a Message. Members can still react using reactions already added to messages without this permission.

pub const VIEW_AUDIT_LOG: Self

Allows viewing a guild’s audit logs.

pub const PRIORITY_SPEAKER: Self

Allows the use of priority speaking in voice channels.

pub const STREAM: Self

Allows the user to go live.

pub const VIEW_CHANNEL: Self

Allows guild members to view a channel, which includes reading messages in text channels and joining voice channels.

pub const SEND_MESSAGES: Self

Allows sending messages in a guild channel.

pub const SEND_TTS_MESSAGES: Self

Allows the sending of text-to-speech messages in a channel.

pub const MANAGE_MESSAGES: Self

Allows the deleting of other messages in a guild channel.

Note: This does not allow the editing of other messages.

pub const EMBED_LINKS: Self

Allows links from this user - or users of this role - to be embedded, with potential data such as a thumbnail, description, and page name.

pub const ATTACH_FILES: Self

Allows uploading of files.

pub const READ_MESSAGE_HISTORY: Self

Allows the reading of a channel’s message history.

pub const MENTION_EVERYONE: Self

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.

pub const USE_EXTERNAL_EMOJIS: Self

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.

pub const VIEW_GUILD_INSIGHTS: Self

Allows for viewing guild insights.

pub const CONNECT: Self

Allows the joining of a voice channel.

pub const SPEAK: Self

Allows the user to speak in a voice channel.

pub const MUTE_MEMBERS: Self

Allows the muting of members in a voice channel.

pub const DEAFEN_MEMBERS: Self

Allows the deafening of members in a voice channel.

pub const MOVE_MEMBERS: Self

Allows the moving of members from one voice channel to another.

pub const USE_VAD: Self

Allows the usage of voice-activity-detection in a voice channel.

If this is disabled, then Members must use push-to-talk.

pub const CHANGE_NICKNAME: Self

Allows members to change their own nickname in the guild.

pub const MANAGE_NICKNAMES: Self

Allows members to change other members’ nicknames.

pub const MANAGE_ROLES: Self

Allows management and editing of roles below their own.

pub const MANAGE_WEBHOOKS: Self

Allows management of webhooks.

pub const MANAGE_GUILD_EXPRESSIONS: Self

Allows for editing and deleting emojis, stickers, and soundboard sounds created by all users.

pub const MANAGE_EMOJIS_AND_STICKERS: Self

👎Deprecated: use Permissions::MANAGE_GUILD_EXPRESSIONS instead

pub const USE_APPLICATION_COMMANDS: Self

Allows members to use application commands, including slash commands and context menu commands.

pub const REQUEST_TO_SPEAK: Self

Allows for requesting to speak in stage channels.

pub const MANAGE_EVENTS: Self

Allows for editing, and deleting scheduled events created by all users.

pub const MANAGE_THREADS: Self

Allows for deleting and archiving threads, and viewing all private threads.

pub const CREATE_PUBLIC_THREADS: Self

Allows for creating threads.

pub const CREATE_PRIVATE_THREADS: Self

Allows for creating private threads.

pub const USE_EXTERNAL_STICKERS: Self

Allows the usage of custom stickers from other servers.

pub const SEND_MESSAGES_IN_THREADS: Self

Allows for sending messages in threads

pub const USE_EMBEDDED_ACTIVITIES: Self

Allows for launching activities in a voice channel

pub const MODERATE_MEMBERS: Self

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.

pub const VIEW_CREATOR_MONETIZATION_ANALYTICS: Self

Allows for viewing role subscription insights.

pub const USE_SOUNDBOARD: Self

Allows for using soundboard in a voice channel.

pub const CREATE_GUILD_EXPRESSIONS: Self

Allows for creating emojis, stickers, and soundboard sounds, and editing and deleting those created by the current user.

pub const CREATE_EVENTS: Self

Allows for creating scheduled events, and editing and deleting those created by the current user.

pub const USE_EXTERNAL_SOUNDS: Self

Allows the usage of custom soundboard sounds from other servers.

pub const SEND_VOICE_MESSAGES: Self

Allows sending voice messages.

pub const SET_VOICE_CHANNEL_STATUS: Self

Allows setting the status of a voice channel.

pub const SEND_POLLS: Self

Allows attaching polls to message sends.

pub const USE_EXTERNAL_APPS: Self

Allows user-installed apps to send public responses.

impl Permissions

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Permissions

pub const fn iter(&self) -> Iter<Permissions>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Permissions>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl Permissions

pub fn get_permission_names(self) -> Vec<&'static str>

Returns a list of names of all contained permissions.

impl Permissions

TODO: use a macro to shorten this entire file lol

pub fn dm_permissions() -> Self

pub const fn add_reactions(self) -> bool

Shorthand for checking that the set of permissions contains the Add Reactions permission.

pub const fn administrator(self) -> bool

Shorthand for checking that the set of permissions contains the Administrator permission.

pub const fn attach_files(self) -> bool

Shorthand for checking that the set of permissions contains the Attach Files permission.

pub const fn ban_members(self) -> bool

Shorthand for checking that the set of permissions contains the Ban Members permission.

pub const fn change_nickname(self) -> bool

Shorthand for checking that the set of permissions contains the Change Nickname permission.

pub const fn connect(self) -> bool

Shorthand for checking that the set of permissions contains the Connect permission.

pub const fn create_events(self) -> bool

Shorthand for checking that the set of permissions contains the Create Events permission.

pub const fn create_guild_expressions(self) -> bool

Shorthand for checking that the set of permissions contains the Create Guild Expressions permission.

pub const fn view_audit_log(self) -> bool

Shorthand for checking that the set of permissions contains the View Audit Log permission.

pub const fn view_channel(self) -> bool

Shorthand for checking that the set of permissions contains the View Channel permission.

pub const fn view_guild_insights(self) -> bool

Shorthand for checking that the set of permissions contains the View Guild Insights permission.

pub const fn priority_speaker(self) -> bool

Shorthand for checking that the set of permission contains the Priority Speaker permission.

pub const fn stream(self) -> bool

Shorthand for checking that the set of permission contains the Stream permission.

pub const fn create_instant_invite(self) -> bool

Shorthand for checking that the set of permissions contains the Create Instant Invite permission.

pub const fn create_private_threads(self) -> bool

Shorthand for checking that the set of permissions contains the Create Private Threads permission.

pub const fn create_public_threads(self) -> bool

Shorthand for checking that the set of permissions contains the Create Public Threads permission.

pub const fn deafen_members(self) -> bool

Shorthand for checking that the set of permissions contains the Deafen Members permission.

pub const fn embed_links(self) -> bool

Shorthand for checking that the set of permissions contains the Embed Links permission.

pub const fn external_emojis(self) -> bool

Shorthand for checking that the set of permissions contains the Use External Emojis permission.

pub const fn kick_members(self) -> bool

Shorthand for checking that the set of permissions contains the Kick Members permission.

pub const fn manage_channels(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Channels permission.

pub const fn manage_emojis_and_stickers(self) -> bool

👎Deprecated: use manage_guild_expressions instead

pub fn manage_events(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Events permission.

pub const fn manage_guild(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Guild permission.

pub const fn manage_guild_expressions(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Guild Expressions permission.

pub const fn manage_messages(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Messages permission.

pub const fn manage_nicknames(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Nicknames permission.

pub const fn manage_roles(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Roles permission.

pub const fn manage_threads(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Threads permission.

pub const fn manage_webhooks(self) -> bool

Shorthand for checking that the set of permissions contains the Manage Webhooks permission.

pub const fn mention_everyone(self) -> bool

Shorthand for checking that the set of permissions contains the Mention Everyone permission.

pub const fn moderate_members(self) -> bool

Shorthand for checking that the set of permissions contains the Moderate Members permission.

pub const fn move_members(self) -> bool

Shorthand for checking that the set of permissions contains the Move Members permission.

pub const fn mute_members(self) -> bool

Shorthand for checking that the set of permissions contains the Mute Members permission.

pub const fn read_message_history(self) -> bool

Shorthand for checking that the set of permissions contains the Read Message History permission.

pub const fn send_messages(self) -> bool

Shorthand for checking that the set of permissions contains the Send Messages permission.

pub const fn send_messages_in_threads(self) -> bool

Shorthand for checking that the set of permissions contains the Send Messages in Threads permission.

pub const fn send_tts_messages(self) -> bool

Shorthand for checking that the set of permissions contains the Send TTS Messages permission.

pub const fn speak(self) -> bool

Shorthand for checking that the set of permissions contains the Speak permission.

pub const fn request_to_speak(self) -> bool

Shorthand for checking that the set of permissions contains the Request To Speak permission.

pub const fn use_embedded_activities(self) -> bool

Shorthand for checking that the set of permissions contains the Use Embedded Activities permission.

pub const fn use_external_emojis(self) -> bool

Shorthand for checking that the set of permissions contains the Use External Emojis permission.

pub const fn use_external_stickers(self) -> bool

Shorthand for checking that the set of permissions contains the Use External Stickers permission.

pub const fn use_commands(self) -> bool

Shorthand for checking that the set of permissions contains the Use Application Commands permission.

pub const fn use_vad(self) -> bool

Shorthand for checking that the set of permissions contains the Use VAD permission.

pub const fn send_polls(self) -> bool

Shorthand for checking that the set of permissions contains the Send Polls permission.

pub const fn use_external_apps(self) -> bool

Shorthand for checking that the set of permissions contains the Use External Apps permission.

Trait Implementations

impl Binary for Permissions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for Permissions

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = Permissions

The resulting type after applying the & operator.

impl BitAndAssign for Permissions

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Permissions

fn bitor(self, other: Permissions) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = Permissions

The resulting type after applying the | operator.

impl BitOrAssign for Permissions

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Permissions

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Permissions

The resulting type after applying the ^ operator.

impl BitXorAssign for Permissions

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for Permissions

fn clone(&self) -> Permissions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Permissions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Permissions

fn default() -> Permissions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Permissions

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Permissions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Extend<Permissions> for Permissions

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for Permissions

const FLAGS: &'static [Flag<Permissions>]

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> Permissions

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Permissions> for Permissions

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for Permissions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Permissions

type Item = Permissions

The type of the elements being iterated over.

type IntoIter = Iter<Permissions>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Permissions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for Permissions

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Permissions

The resulting type after applying the ! operator.

impl Octal for Permissions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Permissions

fn eq(&self, other: &Permissions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Permissions

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sub for Permissions

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Permissions

The resulting type after applying the - operator.

impl SubAssign for Permissions

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Permissions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for Permissions

impl Eq for Permissions

impl StructuralPartialEq for Permissions