pub struct UserPublicFlags { /* private fields */ }
Expand description
User’s public flags
Implementations
sourceimpl UserPublicFlags
impl UserPublicFlags
sourcepub const DISCORD_EMPLOYEE: Self = _
pub const DISCORD_EMPLOYEE: Self = _
User’s flag as discord employee
sourcepub const PARTNERED_SERVER_OWNER: Self = _
pub const PARTNERED_SERVER_OWNER: Self = _
User’s flag as partnered server owner
sourcepub const HYPESQUAD_EVENTS: Self = _
pub const HYPESQUAD_EVENTS: Self = _
User’s flag as hypesquad events
sourcepub const BUG_HUNTER_LEVEL_1: Self = _
pub const BUG_HUNTER_LEVEL_1: Self = _
User’s flag as bug hunter level 1
sourcepub const HOUSE_BRAVERY: Self = _
pub const HOUSE_BRAVERY: Self = _
User’s flag as house bravery
sourcepub const HOUSE_BRILLIANCE: Self = _
pub const HOUSE_BRILLIANCE: Self = _
User’s flag as house brilliance
sourcepub const HOUSE_BALANCE: Self = _
pub const HOUSE_BALANCE: Self = _
User’s flag as house balance
sourcepub const EARLY_SUPPORTER: Self = _
pub const EARLY_SUPPORTER: Self = _
User’s flag as early supporter
sourcepub const BUG_HUNTER_LEVEL_2: Self = _
pub const BUG_HUNTER_LEVEL_2: Self = _
User’s flag as bug hunter level 2
sourcepub const VERIFIED_BOT: Self = _
pub const VERIFIED_BOT: Self = _
User’s flag as verified bot
sourcepub const EARLY_VERIFIED_BOT_DEVELOPER: Self = _
pub const EARLY_VERIFIED_BOT_DEVELOPER: Self = _
User’s flag as early verified bot developer
sourcepub const DISCORD_CERTIFIED_MODERATOR: Self = _
pub const DISCORD_CERTIFIED_MODERATOR: Self = _
User’s flag as discord certified moderator
sourcepub const BOT_HTTP_INTERACTIONS: Self = _
pub const BOT_HTTP_INTERACTIONS: Self = _
Bot’s running with HTTP interactions
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> 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 UserPublicFlags
impl Binary for UserPublicFlags
sourceimpl BitAnd<UserPublicFlags> for UserPublicFlags
impl BitAnd<UserPublicFlags> for UserPublicFlags
type Output = UserPublicFlags
type Output = UserPublicFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<UserPublicFlags> for UserPublicFlags
impl BitAndAssign<UserPublicFlags> for UserPublicFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<UserPublicFlags> for UserPublicFlags
impl BitOr<UserPublicFlags> for UserPublicFlags
sourcefn bitor(self, other: UserPublicFlags) -> Self
fn bitor(self, other: UserPublicFlags) -> Self
Returns the union of the two sets of flags.
type Output = UserPublicFlags
type Output = UserPublicFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<UserPublicFlags> for UserPublicFlags
impl BitOrAssign<UserPublicFlags> for UserPublicFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<UserPublicFlags> for UserPublicFlags
impl BitXor<UserPublicFlags> for UserPublicFlags
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 = UserPublicFlags
type Output = UserPublicFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<UserPublicFlags> for UserPublicFlags
impl BitXorAssign<UserPublicFlags> for UserPublicFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for UserPublicFlags
impl Clone for UserPublicFlags
sourcefn clone(&self) -> UserPublicFlags
fn clone(&self) -> UserPublicFlags
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 UserPublicFlags
impl Debug for UserPublicFlags
sourceimpl Default for UserPublicFlags
impl Default for UserPublicFlags
sourcefn default() -> UserPublicFlags
fn default() -> UserPublicFlags
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for UserPublicFlags
impl<'de> Deserialize<'de> for UserPublicFlags
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<UserPublicFlags> for UserPublicFlags
impl Extend<UserPublicFlags> for UserPublicFlags
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<UserPublicFlags> for UserPublicFlags
impl FromIterator<UserPublicFlags> for UserPublicFlags
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 UserPublicFlags
impl Hash for UserPublicFlags
sourceimpl LowerHex for UserPublicFlags
impl LowerHex for UserPublicFlags
sourceimpl Not for UserPublicFlags
impl Not for UserPublicFlags
type Output = UserPublicFlags
type Output = UserPublicFlags
The resulting type after applying the !
operator.
sourceimpl Octal for UserPublicFlags
impl Octal for UserPublicFlags
sourceimpl Ord for UserPublicFlags
impl Ord for UserPublicFlags
sourcefn cmp(&self, other: &UserPublicFlags) -> Ordering
fn cmp(&self, other: &UserPublicFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<UserPublicFlags> for UserPublicFlags
impl PartialEq<UserPublicFlags> for UserPublicFlags
sourcefn eq(&self, other: &UserPublicFlags) -> bool
fn eq(&self, other: &UserPublicFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UserPublicFlags) -> bool
fn ne(&self, other: &UserPublicFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<UserPublicFlags> for UserPublicFlags
impl PartialOrd<UserPublicFlags> for UserPublicFlags
sourcefn partial_cmp(&self, other: &UserPublicFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &UserPublicFlags) -> 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 UserPublicFlags
impl Serialize for UserPublicFlags
sourceimpl Sub<UserPublicFlags> for UserPublicFlags
impl Sub<UserPublicFlags> for UserPublicFlags
type Output = UserPublicFlags
type Output = UserPublicFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<UserPublicFlags> for UserPublicFlags
impl SubAssign<UserPublicFlags> for UserPublicFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for UserPublicFlags
impl UpperHex for UserPublicFlags
impl Copy for UserPublicFlags
impl Eq for UserPublicFlags
impl StructuralEq for UserPublicFlags
impl StructuralPartialEq for UserPublicFlags
Auto Trait Implementations
impl RefUnwindSafe for UserPublicFlags
impl Send for UserPublicFlags
impl Sync for UserPublicFlags
impl Unpin for UserPublicFlags
impl UnwindSafe for UserPublicFlags
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>
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