Struct twilight_model::guild::Permissions
source · pub struct Permissions { /* private fields */ }
Implementations§
source§impl Permissions
impl Permissions
pub const CREATE_INVITE: Self = _
pub const KICK_MEMBERS: Self = _
pub const BAN_MEMBERS: Self = _
pub const ADMINISTRATOR: Self = _
pub const MANAGE_CHANNELS: Self = _
pub const MANAGE_GUILD: Self = _
pub const ADD_REACTIONS: Self = _
pub const VIEW_AUDIT_LOG: Self = _
pub const PRIORITY_SPEAKER: Self = _
pub const STREAM: Self = _
pub const VIEW_CHANNEL: Self = _
sourcepub const SEND_MESSAGES: Self = _
pub const SEND_MESSAGES: Self = _
Allows for sending messages and creating forum threads, but not sending messages in forum threads.
pub const SEND_TTS_MESSAGES: Self = _
pub const MANAGE_MESSAGES: Self = _
pub const EMBED_LINKS: Self = _
pub const ATTACH_FILES: Self = _
pub const READ_MESSAGE_HISTORY: Self = _
pub const MENTION_EVERYONE: Self = _
pub const USE_EXTERNAL_EMOJIS: Self = _
pub const VIEW_GUILD_INSIGHTS: Self = _
pub const CONNECT: Self = _
pub const SPEAK: Self = _
pub const MUTE_MEMBERS: Self = _
pub const DEAFEN_MEMBERS: Self = _
pub const MOVE_MEMBERS: Self = _
pub const USE_VAD: Self = _
pub const CHANGE_NICKNAME: Self = _
pub const MANAGE_NICKNAMES: Self = _
pub const MANAGE_ROLES: Self = _
pub const MANAGE_WEBHOOKS: Self = _
pub const MANAGE_EMOJIS_AND_STICKERS: Self = _
MANAGE_GUILD_EXPRESSIONS
insteadsourcepub const MANAGE_GUILD_EXPRESSIONS: Self = _
pub const MANAGE_GUILD_EXPRESSIONS: Self = _
Allows management and editing of emojis, stickers, and soundboard sounds.
pub const USE_SLASH_COMMANDS: Self = _
pub const REQUEST_TO_SPEAK: Self = _
sourcepub const MANAGE_EVENTS: Self = _
pub const MANAGE_EVENTS: Self = _
Allows for creating, editing, and deleting scheduled events.
sourcepub const MANAGE_THREADS: Self = _
pub const MANAGE_THREADS: Self = _
Allows for deleting and archiving threads, and viewing all private threads.
sourcepub const CREATE_PUBLIC_THREADS: Self = _
pub const CREATE_PUBLIC_THREADS: Self = _
Allows for creating public threads.
sourcepub const CREATE_PRIVATE_THREADS: Self = _
pub const CREATE_PRIVATE_THREADS: Self = _
Allows for creating private threads.
sourcepub const USE_EXTERNAL_STICKERS: Self = _
pub const USE_EXTERNAL_STICKERS: Self = _
Allows the usage of custom stickers from other servers.
sourcepub const SEND_MESSAGES_IN_THREADS: Self = _
pub const SEND_MESSAGES_IN_THREADS: Self = _
Allows for sending messages in threads.
sourcepub const USE_EMBEDDED_ACTIVITIES: Self = _
pub const USE_EMBEDDED_ACTIVITIES: Self = _
Allows for using activities (applications with the EMBEDDED
flag) in a voice channel.
sourcepub const MODERATE_MEMBERS: Self = _
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.
See Discord’s article on Guild Timeouts.
sourcepub const VIEW_CREATOR_MONETIZATION_ANALYTICS: Self = _
pub const VIEW_CREATOR_MONETIZATION_ANALYTICS: Self = _
Allows for viewing role subscription insights.
sourcepub const USE_SOUNDBOARD: Self = _
pub const USE_SOUNDBOARD: Self = _
Allows for using soundboard in a voice channel
sourcepub const SEND_VOICE_MESSAGES: Self = _
pub const SEND_VOICE_MESSAGES: Self = _
Allows sending voice messages
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for Permissions
impl Binary for Permissions
source§impl BitAnd<Permissions> for Permissions
impl BitAnd<Permissions> for Permissions
source§impl BitAndAssign<Permissions> for Permissions
impl BitAndAssign<Permissions> for Permissions
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<Permissions> for Permissions
impl BitOr<Permissions> for Permissions
source§fn bitor(self, other: Permissions) -> Self
fn bitor(self, other: Permissions) -> Self
Returns the union of the two sets of flags.
§type Output = Permissions
type Output = Permissions
|
operator.source§impl BitOrAssign<Permissions> for Permissions
impl BitOrAssign<Permissions> for Permissions
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<Permissions> for Permissions
impl BitXor<Permissions> for Permissions
source§impl BitXorAssign<Permissions> for Permissions
impl BitXorAssign<Permissions> for Permissions
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for Permissions
impl Clone for Permissions
source§fn clone(&self) -> Permissions
fn clone(&self) -> Permissions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Permissions
impl Debug for Permissions
source§impl<'de> Deserialize<'de> for Permissions
impl<'de> Deserialize<'de> for Permissions
source§fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
source§impl Extend<Permissions> for Permissions
impl Extend<Permissions> for Permissions
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<Permissions> for Permissions
impl FromIterator<Permissions> for Permissions
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for Permissions
impl Hash for Permissions
source§impl LowerHex for Permissions
impl LowerHex for Permissions
source§impl Not for Permissions
impl Not for Permissions
source§impl Octal for Permissions
impl Octal for Permissions
source§impl Ord for Permissions
impl Ord for Permissions
source§fn cmp(&self, other: &Permissions) -> Ordering
fn cmp(&self, other: &Permissions) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<Permissions> for Permissions
impl PartialEq<Permissions> for Permissions
source§fn eq(&self, other: &Permissions) -> bool
fn eq(&self, other: &Permissions) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<Permissions> for Permissions
impl PartialOrd<Permissions> for Permissions
source§fn partial_cmp(&self, other: &Permissions) -> Option<Ordering>
fn partial_cmp(&self, other: &Permissions) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for Permissions
impl Serialize for Permissions
source§impl Sub<Permissions> for Permissions
impl Sub<Permissions> for Permissions
source§impl SubAssign<Permissions> for Permissions
impl SubAssign<Permissions> for Permissions
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.