Struct serenity::model::permissions::Permissions

pub struct Permissions { /* fields omitted */ }

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

Methods

impl Permissions

pub const CREATE_INVITE: Permissions

CREATE_INVITE: Permissions = Permissions{bits: 1,}

Allows for the creation of RichInvites.

pub const KICK_MEMBERS: Permissions

KICK_MEMBERS: Permissions = Permissions{bits: 2,}

Allows for the kicking of guild members.

pub const BAN_MEMBERS: Permissions

BAN_MEMBERS: Permissions = Permissions{bits: 4,}

Allows the banning of guild members.

pub const ADMINISTRATOR: Permissions

ADMINISTRATOR: Permissions = Permissions{bits: 8,}

Allows all permissions, bypassing channel permission overwrites.

pub const MANAGE_CHANNELS: Permissions

MANAGE_CHANNELS: Permissions = Permissions{bits: 16,}

Allows management and editing of guild channels.

pub const MANAGE_GUILD: Permissions

MANAGE_GUILD: Permissions = Permissions{bits: 32,}

Allows management and editing of the guild.

pub const ADD_REACTIONS: Permissions

ADD_REACTIONS: Permissions = Permissions{bits: 64,}

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: Permissions

VIEW_AUDIT_LOG: Permissions = Permissions{bits: 128,}

Allows viewing a guild's audit logs.

pub const PRIORITY_SPEAKER: Permissions

PRIORITY_SPEAKER: Permissions = Permissions{bits: 256,}

Allows the use of priority speaking in voice channels.

pub const READ_MESSAGES: Permissions

READ_MESSAGES: Permissions = Permissions{bits: 1024,}

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.

pub const SEND_MESSAGES: Permissions

SEND_MESSAGES: Permissions = Permissions{bits: 2048,}

Allows sending messages in a guild channel.

pub const SEND_TTS_MESSAGES: Permissions

SEND_TTS_MESSAGES: Permissions = Permissions{bits: 4096,}

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

pub const MANAGE_MESSAGES: Permissions

MANAGE_MESSAGES: Permissions = Permissions{bits: 8192,}

Allows the deleting of other messages in a guild channel.

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

pub const EMBED_LINKS: Permissions

EMBED_LINKS: Permissions = Permissions{bits: 16384,}

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: Permissions

ATTACH_FILES: Permissions = Permissions{bits: 32768,}

Allows uploading of files.

pub const READ_MESSAGE_HISTORY: Permissions

READ_MESSAGE_HISTORY: Permissions = Permissions{bits: 65536,}

Allows the reading of a channel's message history.

pub const MENTION_EVERYONE: Permissions

MENTION_EVERYONE: Permissions = Permissions{bits: 131072,}

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: Permissions

USE_EXTERNAL_EMOJIS: Permissions = Permissions{bits: 262144,}

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 CONNECT: Permissions

CONNECT: Permissions = Permissions{bits: 1048576,}

Allows the joining of a voice channel.

pub const SPEAK: Permissions

SPEAK: Permissions = Permissions{bits: 2097152,}

Allows the user to speak in a voice channel.

pub const MUTE_MEMBERS: Permissions

MUTE_MEMBERS: Permissions = Permissions{bits: 4194304,}

Allows the muting of members in a voice channel.

pub const DEAFEN_MEMBERS: Permissions

DEAFEN_MEMBERS: Permissions = Permissions{bits: 8388608,}

Allows the deafening of members in a voice channel.

pub const MOVE_MEMBERS: Permissions

MOVE_MEMBERS: Permissions = Permissions{bits: 16777216,}

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

pub const USE_VAD: Permissions

USE_VAD: Permissions = Permissions{bits: 33554432,}

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: Permissions

CHANGE_NICKNAME: Permissions = Permissions{bits: 67108864,}

Allows members to change their own nickname in the guild.

pub const MANAGE_NICKNAMES: Permissions

MANAGE_NICKNAMES: Permissions = Permissions{bits: 134217728,}

Allows members to change other members' nicknames.

pub const MANAGE_ROLES: Permissions

MANAGE_ROLES: Permissions = Permissions{bits: 268435456,}

Allows management and editing of roles below their own.

pub const MANAGE_WEBHOOKS: Permissions

MANAGE_WEBHOOKS: Permissions = Permissions{bits: 536870912,}

Allows management of webhooks.

pub const MANAGE_EMOJIS: Permissions

MANAGE_EMOJIS: Permissions = Permissions{bits: 1073741824,}

Allows management of emojis created without the use of an Integration.

pub fn empty() -> Permissions

Returns an empty set of flags.

pub fn all() -> Permissions

Returns the set containing all flags.

pub fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u64) -> Permissions

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

impl Permissions

pub fn add_reactions(&self) -> bool

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

pub fn administrator(&self) -> bool

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

pub fn attach_files(&self) -> bool

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

pub fn ban_members(&self) -> bool

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

pub fn change_nickname(&self) -> bool

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

pub fn connect(&self) -> bool

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

pub fn view_audit_log(&self) -> bool

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

pub fn priority_speaker(&self) -> bool

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

pub fn create_invite(&self) -> bool

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

pub fn deafen_members(&self) -> bool

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

pub fn embed_links(&self) -> bool

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

pub fn external_emojis(&self) -> bool

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

pub fn kick_members(&self) -> bool

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

pub fn manage_channels(&self) -> bool

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

pub fn manage_emojis(&self) -> bool

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

pub fn manage_guild(&self) -> bool

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

pub fn manage_messages(&self) -> bool

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

pub fn manage_nicknames(&self) -> bool

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

pub fn manage_roles(&self) -> bool

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

pub fn manage_webhooks(&self) -> bool

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

pub fn mention_everyone(&self) -> bool

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

pub fn move_members(&self) -> bool

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

pub fn mute_members(&self) -> bool

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

pub fn read_message_history(&self) -> bool

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

pub fn read_messages(&self) -> bool

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

pub fn send_messages(&self) -> bool

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

pub fn send_tts_messages(&self) -> bool

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

pub fn speak(&self) -> bool

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

pub fn use_external_emojis(&self) -> bool

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

pub fn use_vad(&self) -> bool

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

Trait Implementations

impl Copy for Permissions

impl PartialEq for Permissions

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Permissions

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 PartialOrd for Permissions

fn partial_cmp(&self, other: &Permissions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for Permissions

fn cmp(&self, other: &Permissions) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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,

Feeds a slice of this type into the given [Hasher].

impl Debug for Permissions

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

Formats the value using the given formatter.

impl Binary for Permissions

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

Formats the value using the given formatter.

impl Octal for Permissions

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

Formats the value using the given formatter.

impl LowerHex for Permissions

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

Formats the value using the given formatter.

impl UpperHex for Permissions

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

Formats the value using the given formatter.

impl BitOr for Permissions

type Output = Permissions

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign for Permissions

fn bitor_assign(&mut self, other: Permissions)

Adds the set of flags.

impl BitXor for Permissions

type Output = Permissions

The resulting type after applying the ^ operator.

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

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign for Permissions

fn bitxor_assign(&mut self, other: Permissions)

Toggles the set of flags.

impl BitAnd for Permissions

type Output = Permissions

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign for Permissions

fn bitand_assign(&mut self, other: Permissions)

Disables all flags disabled in the set.

impl Sub for Permissions

type Output = Permissions

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign for Permissions

fn sub_assign(&mut self, other: Permissions)

Disables all flags enabled in the set.

impl Not for Permissions

type Output = Permissions

The resulting type after applying the ! operator.

fn not(self) -> Permissions

Returns the complement of this set of flags.

impl Extend<Permissions> for Permissions

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

Extends a collection with the contents of an iterator.

impl FromIterator<Permissions> for Permissions

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

Creates a value from an iterator.

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 Serialize for Permissions

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

Serialize this value into the given Serde serializer.