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

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

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 fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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.

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

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

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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

impl Binary for Permissions

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

Formats the value using the given formatter.

impl BitAnd<Permissions> for Permissions

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

Returns the intersection between the two sets of flags.

type Output = Permissions

The resulting type after applying the & operator.

impl BitAndAssign<Permissions> for Permissions

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<Permissions> for Permissions

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

Returns the union of the two sets of flags.

type Output = Permissions

The resulting type after applying the | operator.

impl BitOrAssign<Permissions> for Permissions

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<Permissions> for Permissions

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

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

type Output = Permissions

The resulting type after applying the ^ operator.

impl BitXorAssign<Permissions> for Permissions

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

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)

Extends a collection with the contents of an iterator.

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

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

Creates a value from an iterator.

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

Returns the complement of this set of flags.

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

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Permissions> 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 PartialOrd<Permissions> 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: &Rhs) -> bool

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

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

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

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

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

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

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

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

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

Returns the set difference of the two sets of flags.

type Output = Permissions

The resulting type after applying the - operator.

impl SubAssign<Permissions> for Permissions

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

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

impl StructuralPartialEq for Permissions