pub struct ActivityFlags { /* private fields */ }
Expand description
A set of flags defining what is in an activity’s payload.
Implementations
sourceimpl ActivityFlags
impl ActivityFlags
sourcepub const JOIN_REQUEST: Self = Self{bits: 1 << 3,}
pub const JOIN_REQUEST: Self = Self{bits: 1 << 3,}
Whether a request can be sent to join the user’s party.
sourcepub const PARTY_PRIVACY_FRIENDS: Self = Self{bits: 1 << 6,}
pub const PARTY_PRIVACY_FRIENDS: Self = Self{bits: 1 << 6,}
Whether the activity party is friend only.
sourcepub const PARTY_PRIVACY_VOICE_CHANNEL: Self = Self{bits: 1 << 7,}
pub const PARTY_PRIVACY_VOICE_CHANNEL: Self = Self{bits: 1 << 7,}
Whether the activity party is in a voice channel.
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
sourceimpl Binary for ActivityFlags
impl Binary for ActivityFlags
sourceimpl BitAnd<ActivityFlags> for ActivityFlags
impl BitAnd<ActivityFlags> for ActivityFlags
type Output = ActivityFlags
type Output = ActivityFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<ActivityFlags> for ActivityFlags
impl BitAndAssign<ActivityFlags> for ActivityFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ActivityFlags> for ActivityFlags
impl BitOr<ActivityFlags> for ActivityFlags
sourcefn bitor(self, other: ActivityFlags) -> Self
fn bitor(self, other: ActivityFlags) -> Self
Returns the union of the two sets of flags.
type Output = ActivityFlags
type Output = ActivityFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ActivityFlags> for ActivityFlags
impl BitOrAssign<ActivityFlags> for ActivityFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ActivityFlags> for ActivityFlags
impl BitXor<ActivityFlags> for ActivityFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = ActivityFlags
type Output = ActivityFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<ActivityFlags> for ActivityFlags
impl BitXorAssign<ActivityFlags> for ActivityFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ActivityFlags
impl Clone for ActivityFlags
sourcefn clone(&self) -> ActivityFlags
fn clone(&self) -> ActivityFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ActivityFlags
impl Debug for ActivityFlags
sourceimpl Default for ActivityFlags
impl Default for ActivityFlags
sourcefn default() -> ActivityFlags
fn default() -> ActivityFlags
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for ActivityFlags
impl<'de> Deserialize<'de> for ActivityFlags
sourcefn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Extend<ActivityFlags> for ActivityFlags
impl Extend<ActivityFlags> for ActivityFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<ActivityFlags> for ActivityFlags
impl FromIterator<ActivityFlags> for ActivityFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for ActivityFlags
impl Hash for ActivityFlags
sourceimpl LowerHex for ActivityFlags
impl LowerHex for ActivityFlags
sourceimpl Not for ActivityFlags
impl Not for ActivityFlags
type Output = ActivityFlags
type Output = ActivityFlags
The resulting type after applying the !
operator.
sourceimpl Octal for ActivityFlags
impl Octal for ActivityFlags
sourceimpl Ord for ActivityFlags
impl Ord for ActivityFlags
sourceimpl PartialEq<ActivityFlags> for ActivityFlags
impl PartialEq<ActivityFlags> for ActivityFlags
sourcefn eq(&self, other: &ActivityFlags) -> bool
fn eq(&self, other: &ActivityFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ActivityFlags) -> bool
fn ne(&self, other: &ActivityFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ActivityFlags> for ActivityFlags
impl PartialOrd<ActivityFlags> for ActivityFlags
sourcefn partial_cmp(&self, other: &ActivityFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ActivityFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Serialize for ActivityFlags
impl Serialize for ActivityFlags
sourceimpl Sub<ActivityFlags> for ActivityFlags
impl Sub<ActivityFlags> for ActivityFlags
type Output = ActivityFlags
type Output = ActivityFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<ActivityFlags> for ActivityFlags
impl SubAssign<ActivityFlags> for ActivityFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ActivityFlags
impl UpperHex for ActivityFlags
impl Copy for ActivityFlags
impl Eq for ActivityFlags
impl StructuralEq for ActivityFlags
impl StructuralPartialEq for ActivityFlags
Auto Trait Implementations
impl RefUnwindSafe for ActivityFlags
impl Send for ActivityFlags
impl Sync for ActivityFlags
impl Unpin for ActivityFlags
impl UnwindSafe for ActivityFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more