Struct serenity::model::application::ApplicationFlags

#[non_exhaustive]
pub struct ApplicationFlags { /* fields omitted */ }

The flags of the application.

Implementations

impl ApplicationFlags

pub fn from_u64(bits: u64) -> Self

impl ApplicationFlags

pub const GATEWAY_PRESENCE: Self

pub const GATEWAY_PRESENCE_LIMITED: Self

pub const GATEWAY_GUILD_MEMBERS: Self

pub const GATEWAY_GUILD_MEMBERS_LIMITED: Self

pub const VERIFICATION_PENDING_GUILD_LIMIT: Self

pub const EMBEDDED: Self

pub const GATEWAY_MESSAGE_CONTENT: Self

pub const GATEWAY_MESSAGE_CONTENT_LIMITED: Self

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 ApplicationFlags

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

Formats the value using the given formatter.

impl BitAnd<ApplicationFlags> for ApplicationFlags

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

Returns the intersection between the two sets of flags.

type Output = Self

The resulting type after applying the & operator.

impl BitAndAssign<ApplicationFlags> for ApplicationFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<ApplicationFlags> for ApplicationFlags

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

Returns the union of the two sets of flags.

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<ApplicationFlags> for ApplicationFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<ApplicationFlags> for ApplicationFlags

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

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

type Output = Self

The resulting type after applying the ^ operator.

impl BitXorAssign<ApplicationFlags> for ApplicationFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for ApplicationFlags

fn clone(&self) -> ApplicationFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApplicationFlags

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApplicationFlags

fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> StdResult<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Extend<ApplicationFlags> for ApplicationFlags

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

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

Creates a value from an iterator.

impl LowerHex for ApplicationFlags

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

Formats the value using the given formatter.

impl Not for ApplicationFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Self

The resulting type after applying the ! operator.

impl Octal for ApplicationFlags

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

Formats the value using the given formatter.

impl Serialize for ApplicationFlags

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

Serialize this value into the given Serde serializer.

impl Sub<ApplicationFlags> for ApplicationFlags

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

Returns the set difference of the two sets of flags.

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<ApplicationFlags> for ApplicationFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for ApplicationFlags

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

Formats the value using the given formatter.