pub struct UserPublicFlags { /* private fields */ }
Expand description

User’s public flags

Discord docs.

Implementations§

source§

impl UserPublicFlags

source

pub const DISCORD_EMPLOYEE: UserPublicFlags = _

User’s flag as discord employee

source

pub const PARTNERED_SERVER_OWNER: UserPublicFlags = _

User’s flag as partnered server owner

source

pub const HYPESQUAD_EVENTS: UserPublicFlags = _

User’s flag as hypesquad events

source

pub const BUG_HUNTER_LEVEL_1: UserPublicFlags = _

User’s flag as bug hunter level 1

source

pub const HOUSE_BRAVERY: UserPublicFlags = _

User’s flag as house bravery

source

pub const HOUSE_BRILLIANCE: UserPublicFlags = _

User’s flag as house brilliance

source

pub const HOUSE_BALANCE: UserPublicFlags = _

User’s flag as house balance

source

pub const EARLY_SUPPORTER: UserPublicFlags = _

User’s flag as early supporter

source

pub const TEAM_USER: UserPublicFlags = _

User’s flag as team user

source

pub const SYSTEM: UserPublicFlags = _

User’s flag as system

source

pub const BUG_HUNTER_LEVEL_2: UserPublicFlags = _

User’s flag as bug hunter level 2

source

pub const VERIFIED_BOT: UserPublicFlags = _

User’s flag as verified bot

source

pub const EARLY_VERIFIED_BOT_DEVELOPER: UserPublicFlags = _

User’s flag as early verified bot developer

source

pub const DISCORD_CERTIFIED_MODERATOR: UserPublicFlags = _

User’s flag as discord certified moderator

source

pub const BOT_HTTP_INTERACTIONS: UserPublicFlags = _

Bot’s running with HTTP interactions

source

pub const ACTIVE_DEVELOPER: UserPublicFlags = _

User’s flag as active developer

source

pub const fn empty() -> UserPublicFlags

Returns an empty set of flags.

source

pub const fn all() -> UserPublicFlags

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

pub const fn from_bits(bits: u32) -> Option<UserPublicFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

source

pub const fn from_bits_truncate(bits: u32) -> UserPublicFlags

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

source

pub const unsafe fn from_bits_unchecked(bits: u32) -> UserPublicFlags

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.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

source

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

Removes the specified flags in-place.

source

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

Toggles the specified flags in-place.

source

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

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

source

pub const fn intersection(self, other: UserPublicFlags) -> UserPublicFlags

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.

source

pub const fn union(self, other: UserPublicFlags) -> UserPublicFlags

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.

source

pub const fn difference(self, other: UserPublicFlags) -> UserPublicFlags

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.

source

pub const fn symmetric_difference( self, other: UserPublicFlags ) -> UserPublicFlags

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.

source

pub const fn complement(self) -> UserPublicFlags

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§

source§

impl Binary for UserPublicFlags

source§

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

Formats the value using the given formatter.
source§

impl BitAnd<UserPublicFlags> for UserPublicFlags

source§

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

Returns the intersection between the two sets of flags.

§

type Output = UserPublicFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign<UserPublicFlags> for UserPublicFlags

source§

fn bitand_assign(&mut self, other: UserPublicFlags)

Disables all flags disabled in the set.

source§

impl BitOr<UserPublicFlags> for UserPublicFlags

source§

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

Returns the union of the two sets of flags.

§

type Output = UserPublicFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign<UserPublicFlags> for UserPublicFlags

source§

fn bitor_assign(&mut self, other: UserPublicFlags)

Adds the set of flags.

source§

impl BitXor<UserPublicFlags> for UserPublicFlags

source§

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

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

§

type Output = UserPublicFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign<UserPublicFlags> for UserPublicFlags

source§

fn bitxor_assign(&mut self, other: UserPublicFlags)

Toggles the set of flags.

source§

impl Clone for UserPublicFlags

source§

fn clone(&self) -> UserPublicFlags

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for UserPublicFlags

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for UserPublicFlags

source§

fn default() -> UserPublicFlags

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for UserPublicFlags

source§

fn deserialize<D>( deserializer: D ) -> Result<UserPublicFlags, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Extend<UserPublicFlags> for UserPublicFlags

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl FromIterator<UserPublicFlags> for UserPublicFlags

source§

fn from_iter<T>(iterator: T) -> UserPublicFlagswhere T: IntoIterator<Item = UserPublicFlags>,

Creates a value from an iterator. Read more
source§

impl Hash for UserPublicFlags

source§

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for UserPublicFlags

source§

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

Formats the value using the given formatter.
source§

impl Not for UserPublicFlags

source§

fn not(self) -> UserPublicFlags

Returns the complement of this set of flags.

§

type Output = UserPublicFlags

The resulting type after applying the ! operator.
source§

impl Octal for UserPublicFlags

source§

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

Formats the value using the given formatter.
source§

impl Ord for UserPublicFlags

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<UserPublicFlags> for UserPublicFlags

source§

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

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

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

impl PartialOrd<UserPublicFlags> for UserPublicFlags

source§

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 · source§

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 · source§

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
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for UserPublicFlags

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Sub<UserPublicFlags> for UserPublicFlags

source§

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

Returns the set difference of the two sets of flags.

§

type Output = UserPublicFlags

The resulting type after applying the - operator.
source§

impl SubAssign<UserPublicFlags> for UserPublicFlags

source§

fn sub_assign(&mut self, other: UserPublicFlags)

Disables all flags enabled in the set.

source§

impl UpperHex for UserPublicFlags

source§

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

Formats the value using the given formatter.
source§

impl Copy for UserPublicFlags

source§

impl Eq for UserPublicFlags

source§

impl StructuralEq for UserPublicFlags

source§

impl StructuralPartialEq for UserPublicFlags

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,