Struct twilight_model::guild::Permissions

pub struct Permissions(/* private fields */);

Implementations

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 = _

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 = _

👎Deprecated since 0.15.2: use MANAGE_GUILD_EXPRESSIONS instead

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 = _

pub const MANAGE_EVENTS: Self = _

Allows for creating, editing, and deleting scheduled events.

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 public 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 using activities (applications with the EMBEDDED flag) 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.

See Discord’s article on Guild Timeouts.

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 USE_EXTERNAL_SOUNDS: Self = _

Allows the usage of custom soundboard sounds from other servers

pub const SEND_VOICE_MESSAGES: Self = _

Allows sending voice messages

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.

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<'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 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

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

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

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

impl PublicFlags for Permissions

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

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