[−][src]Struct serenity::model::permissions::Permissions
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.
Fields
bits: u64
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.
Implementations
impl Permissions
[src]
pub const CREATE_INVITE: Permissions
[src]
Allows for the creation of RichInvite
s.
pub const KICK_MEMBERS: Permissions
[src]
Allows for the kicking of guild members.
pub const BAN_MEMBERS: Permissions
[src]
Allows the banning of guild members.
pub const ADMINISTRATOR: Permissions
[src]
Allows all permissions, bypassing channel permission overwrites.
pub const MANAGE_CHANNELS: Permissions
[src]
Allows management and editing of guild channels.
pub const MANAGE_GUILD: Permissions
[src]
Allows management and editing of the guild.
pub const ADD_REACTIONS: Permissions
[src]
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.
pub const VIEW_AUDIT_LOG: Permissions
[src]
Allows viewing a guild's audit logs.
pub const PRIORITY_SPEAKER: Permissions
[src]
Allows the use of priority speaking in voice channels.
pub const READ_MESSAGES: Permissions
[src]
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
[src]
Allows sending messages in a guild channel.
pub const SEND_TTS_MESSAGES: Permissions
[src]
Allows the sending of text-to-speech messages in a channel.
pub const MANAGE_MESSAGES: Permissions
[src]
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
[src]
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
[src]
Allows uploading of files.
pub const READ_MESSAGE_HISTORY: Permissions
[src]
Allows the reading of a channel's message history.
pub const MENTION_EVERYONE: Permissions
[src]
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
[src]
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
[src]
Allows the joining of a voice channel.
pub const SPEAK: Permissions
[src]
Allows the user to speak in a voice channel.
pub const MUTE_MEMBERS: Permissions
[src]
Allows the muting of members in a voice channel.
pub const DEAFEN_MEMBERS: Permissions
[src]
Allows the deafening of members in a voice channel.
pub const MOVE_MEMBERS: Permissions
[src]
Allows the moving of members from one voice channel to another.
pub const USE_VAD: Permissions
[src]
Allows the usage of voice-activity-detection in a voice channel.
If this is disabled, then Member
s must use push-to-talk.
pub const CHANGE_NICKNAME: Permissions
[src]
Allows members to change their own nickname in the guild.
pub const MANAGE_NICKNAMES: Permissions
[src]
Allows members to change other members' nicknames.
pub const MANAGE_ROLES: Permissions
[src]
Allows management and editing of roles below their own.
pub const MANAGE_WEBHOOKS: Permissions
[src]
Allows management of webhooks.
pub const MANAGE_EMOJIS: Permissions
[src]
Allows management of emojis created without the use of an
Integration
.
pub const fn empty() -> Permissions
[src]
Returns an empty set of flags
pub const fn all() -> Permissions
[src]
Returns the set containing all flags.
pub const fn bits(&self) -> u64
[src]
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u64) -> Option<Permissions>
[src]
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u64) -> Permissions
[src]
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u64) -> Permissions
[src]
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
[src]
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
[src]
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: Permissions) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: Permissions) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: Permissions)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: Permissions)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: Permissions)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: Permissions, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
impl Permissions
[src]
pub fn add_reactions(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Add Reactions permission.
pub fn administrator(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Administrator permission.
pub fn attach_files(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Attach Files permission.
pub fn ban_members(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Ban Members permission.
pub fn change_nickname(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Change Nickname permission.
pub fn connect(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Connect permission.
pub fn view_audit_log(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the View Audit Log permission.
pub fn priority_speaker(self) -> bool
[src]
Shorthand for checking that the set of permission contains the Priority Speaker permission.
pub fn create_invite(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Create Invite permission.
pub fn deafen_members(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Deafen Members permission.
pub fn embed_links(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Embed Links permission.
pub fn external_emojis(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Use External Emojis permission.
pub fn kick_members(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Kick Members permission.
pub fn manage_channels(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Manage Channels permission.
pub fn manage_emojis(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Manage Emojis permission.
pub fn manage_guild(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Manage Guild permission.
pub fn manage_messages(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Manage Messages permission.
pub fn manage_nicknames(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Manage Nicknames permission.
pub fn manage_roles(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Manage Roles permission.
pub fn manage_webhooks(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Manage Webhooks permission.
pub fn mention_everyone(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Mention Everyone permission.
pub fn move_members(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Move Members permission.
pub fn mute_members(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Mute Members permission.
pub fn read_message_history(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Read Message History permission.
pub fn read_messages(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Read Messages permission.
pub fn send_messages(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Send Messages permission.
pub fn send_tts_messages(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Send TTS Messages permission.
pub fn speak(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Speak permission.
pub fn use_external_emojis(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Use External Emojis permission.
pub fn use_vad(self) -> bool
[src]
Shorthand for checking that the set of permissions contains the Use VAD permission.
Trait Implementations
impl Binary for Permissions
[src]
impl BitAnd<Permissions> for Permissions
[src]
type Output = Permissions
The resulting type after applying the &
operator.
pub fn bitand(self, other: Permissions) -> Permissions
[src]
Returns the intersection between the two sets of flags.
impl BitAndAssign<Permissions> for Permissions
[src]
pub fn bitand_assign(&mut self, other: Permissions)
[src]
Disables all flags disabled in the set.
impl BitOr<Permissions> for Permissions
[src]
type Output = Permissions
The resulting type after applying the |
operator.
pub fn bitor(self, other: Permissions) -> Permissions
[src]
Returns the union of the two sets of flags.
impl BitOrAssign<Permissions> for Permissions
[src]
pub fn bitor_assign(&mut self, other: Permissions)
[src]
Adds the set of flags.
impl BitXor<Permissions> for Permissions
[src]
type Output = Permissions
The resulting type after applying the ^
operator.
pub fn bitxor(self, other: Permissions) -> Permissions
[src]
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<Permissions> for Permissions
[src]
pub fn bitxor_assign(&mut self, other: Permissions)
[src]
Toggles the set of flags.
impl Clone for Permissions
[src]
pub fn clone(&self) -> Permissions
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for Permissions
[src]
impl Debug for Permissions
[src]
impl Default for Permissions
[src]
impl<'de> Deserialize<'de> for Permissions
[src]
pub fn deserialize<D: Deserializer<'de>>(
deserializer: D
) -> Result<Self, D::Error>
[src]
deserializer: D
) -> Result<Self, D::Error>
impl Eq for Permissions
[src]
impl Extend<Permissions> for Permissions
[src]
pub fn extend<T: IntoIterator<Item = Permissions>>(&mut self, iterator: T)
[src]
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl FromIterator<Permissions> for Permissions
[src]
pub fn from_iter<T: IntoIterator<Item = Permissions>>(
iterator: T
) -> Permissions
[src]
iterator: T
) -> Permissions
impl Hash for Permissions
[src]
pub fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for Permissions
[src]
impl Not for Permissions
[src]
type Output = Permissions
The resulting type after applying the !
operator.
pub fn not(self) -> Permissions
[src]
Returns the complement of this set of flags.
impl Octal for Permissions
[src]
impl Ord for Permissions
[src]
pub fn cmp(&self, other: &Permissions) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Permissions> for Permissions
[src]
pub fn eq(&self, other: &Permissions) -> bool
[src]
pub fn ne(&self, other: &Permissions) -> bool
[src]
impl PartialOrd<Permissions> for Permissions
[src]
pub fn partial_cmp(&self, other: &Permissions) -> Option<Ordering>
[src]
pub fn lt(&self, other: &Permissions) -> bool
[src]
pub fn le(&self, other: &Permissions) -> bool
[src]
pub fn gt(&self, other: &Permissions) -> bool
[src]
pub fn ge(&self, other: &Permissions) -> bool
[src]
impl Serialize for Permissions
[src]
impl StructuralEq for Permissions
[src]
impl StructuralPartialEq for Permissions
[src]
impl Sub<Permissions> for Permissions
[src]
type Output = Permissions
The resulting type after applying the -
operator.
pub fn sub(self, other: Permissions) -> Permissions
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<Permissions> for Permissions
[src]
pub fn sub_assign(&mut self, other: Permissions)
[src]
Disables all flags enabled in the set.
impl UpperHex for Permissions
[src]
Auto Trait Implementations
impl RefUnwindSafe for Permissions
[src]
impl Send for Permissions
[src]
impl Sync for Permissions
[src]
impl Unpin for Permissions
[src]
impl UnwindSafe for Permissions
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> CloneAny for T where
T: Clone + Any,
[src]
T: Clone + Any,
pub fn clone_any(&self) -> Box<dyn CloneAny + 'static, Global>
[src]
pub fn clone_any_send(&self) -> Box<dyn CloneAny + 'static + Send, Global> where
T: Send,
[src]
T: Send,
pub fn clone_any_sync(&self) -> Box<dyn CloneAny + 'static + Sync, Global> where
T: Sync,
[src]
T: Sync,
pub fn clone_any_send_sync(
&self
) -> Box<dyn CloneAny + 'static + Send + Sync, Global> where
T: Send + Sync,
[src]
&self
) -> Box<dyn CloneAny + 'static + Send + Sync, Global> where
T: Send + Sync,
impl<T> DebugAny for T where
T: Any + Debug,
[src]
T: Any + Debug,
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> UnsafeAny for T where
T: Any,
T: Any,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,