Struct serenity::model::gateway::ActivityFlags

pub struct ActivityFlags { /* fields omitted */ }

A set of flags defining what is in an activity's payload.

Methods

impl ActivityFlags

pub const INSTANCE: ActivityFlags

Whether the activity is an instance activity.

pub const JOIN: ActivityFlags

Whether the activity is joinable.

pub const SPECTATE: ActivityFlags

Whether the activity can be spectated.

pub const JOIN_REQUEST: ActivityFlags

Whether a request can be sent to join the user's party.

pub const SYNC: ActivityFlags

Whether the activity can be synced.

pub const PLAY: ActivityFlags

Whether the activity can be played.

pub const fn empty() -> ActivityFlags

Returns an empty set of flags

pub const fn all() -> ActivityFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<ActivityFlags>

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

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

pub const unsafe fn from_bits_unchecked(bits: u64) -> ActivityFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: ActivityFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ActivityFlags

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

Formats the value using the given formatter.

impl BitAnd<ActivityFlags> for ActivityFlags

type Output = ActivityFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ActivityFlags> for ActivityFlags

fn bitand_assign(&mut self, other: ActivityFlags)

Disables all flags disabled in the set.

impl BitOr<ActivityFlags> for ActivityFlags

type Output = ActivityFlags

The resulting type after applying the | operator.

fn bitor(self, other: ActivityFlags) -> ActivityFlags

Returns the union of the two sets of flags.

impl BitOrAssign<ActivityFlags> for ActivityFlags

fn bitor_assign(&mut self, other: ActivityFlags)

Adds the set of flags.

impl BitXor<ActivityFlags> for ActivityFlags

type Output = ActivityFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ActivityFlags> for ActivityFlags

fn bitxor_assign(&mut self, other: ActivityFlags)

Toggles the set of flags.

impl Clone for ActivityFlags

fn clone(&self) -> ActivityFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ActivityFlags

impl Debug for ActivityFlags

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ActivityFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for ActivityFlags

impl Extend<ActivityFlags> for ActivityFlags

fn extend<T: IntoIterator<Item = ActivityFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<ActivityFlags> for ActivityFlags

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

Creates a value from an iterator.

impl Hash for ActivityFlags

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 ActivityFlags

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

Formats the value using the given formatter.

impl Not for ActivityFlags

type Output = ActivityFlags

The resulting type after applying the ! operator.

fn not(self) -> ActivityFlags

Returns the complement of this set of flags.

impl Octal for ActivityFlags

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

Formats the value using the given formatter.

impl Ord for ActivityFlags

fn cmp(&self, other: &ActivityFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ActivityFlags> for ActivityFlags

fn eq(&self, other: &ActivityFlags) -> bool

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

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

This method tests for !=.

impl PartialOrd<ActivityFlags> for ActivityFlags

fn partial_cmp(&self, other: &ActivityFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ActivityFlags) -> bool

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

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

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

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

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

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

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

impl Serialize for ActivityFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for ActivityFlags

impl StructuralPartialEq for ActivityFlags

impl Sub<ActivityFlags> for ActivityFlags

type Output = ActivityFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ActivityFlags> for ActivityFlags

fn sub_assign(&mut self, other: ActivityFlags)

Disables all flags enabled in the set.

impl UpperHex for ActivityFlags

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

Formats the value using the given formatter.