Rights

Struct Rights 

Source
pub struct Rights(/* private fields */);

Implementations§

Source§

impl Rights

Source

pub const OPERATOR: Self

Source

pub const MANAGE_APPLICATIONS: Self

Source

pub const MANAGE_GUILDS: Self

Source

pub const MANAGE_MESSAGES: Self

Source

pub const MANAGE_RATE_LIMITS: Self

Source

pub const MANAGE_ROUTING: Self

Source

pub const MANAGE_TICKETS: Self

Source

pub const MANAGE_USERS: Self

Source

pub const ADD_MEMBERS: Self

Source

pub const BYPASS_RATE_LIMITS: Self

Source

pub const CREATE_APPLICATIONS: Self

Source

pub const CREATE_CHANNELS: Self

Source

pub const CREATE_DMS: Self

Source

pub const CREATE_DM_GROUPS: Self

Source

pub const CREATE_GUILDS: Self

Source

pub const CREATE_INVITES: Self

Source

pub const CREATE_ROLES: Self

Source

pub const CREATE_TEMPLATES: Self

Source

pub const CREATE_WEBHOOKS: Self

Source

pub const JOIN_GUILDS: Self

Source

pub const PIN_MESSAGES: Self

Source

pub const SELF_ADD_REACTIONS: Self

Source

pub const SELF_DELETE_MESSAGES: Self

Source

pub const SELF_EDIT_MESSAGES: Self

Source

pub const SELF_EDIT_NAME: Self

Source

pub const SEND_MESSAGES: Self

Source

pub const USE_ACTIVITIES: Self

Source

pub const USE_VIDEO: Self

Source

pub const USE_VOICE: Self

Source

pub const INVITE_USERS: Self

Source

pub const SELF_DELETE_DISABLE: Self

Source

pub const DEBTABLE: Self

Source

pub const CREDITABLE: Self

Source

pub const KICK_BAN_MEMBERS: Self

Source

pub const SELF_LEAVE_GROUPS: Self

Source

pub const PRESENCE: Self

Source

pub const SELF_ADD_DISCOVERABLE: Self

Source

pub const MANAGE_GUILD_DIRECTORY: Self

Source

pub const POGGERS: Self

Source

pub const USE_ACHIEVEMENTS: Self

Source

pub const INITIATE_INTERACTIONS: Self

Source

pub const RESPOND_TO_INTERACTIONS: Self

Source

pub const SEND_BACKDATED_EVENTS: Self

Source

pub const USE_MASS_INVITES: Self

Source

pub const ACCEPT_INVITES: Self

Source

pub const SELF_EDIT_FLAGS: Self

Source

pub const EDIT_FLAGS: Self

Source

pub const MANAGE_GROUPS: Self

Source

pub const VIEW_SERVER_STATS: Self

Source

pub const RESEND_VERIFICATION_EMAIL: Self

Source§

impl Rights

Source

pub const fn empty() -> Self

Get a flags value with all bits unset.

Source

pub const fn all() -> Self

Get a flags value with all known bits set.

Source

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

Source

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

Convert from a bits value.

This method will return None if any unknown bits are set.

Source

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

Source

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

Source

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

Source

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

Source

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

Source

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

Whether any set bits in a source flags value are also set in a target flags value.

Source

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

Whether all set bits in a source flags value are also set in a target flags value.

Source

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

The bitwise or (|) of the bits in two flags values.

Source

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

Source

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

The bitwise exclusive-or (^) of the bits in two flags values.

Source

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

Call insert when value is true or remove when value is false.

Source

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

The bitwise and (&) of the bits in two flags values.

Source

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

The bitwise or (|) of the bits in two flags values.

Source

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

Source

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

The bitwise exclusive-or (^) of the bits in two flags values.

Source

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

Source§

impl Rights

Source

pub const fn iter(&self) -> Iter<Rights>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

Source

pub const fn iter_names(&self) -> IterNames<Rights>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Source§

impl Rights

Source

pub fn any(&self, permission: Rights, check_operator: bool) -> bool

Source

pub fn has(&self, permission: Rights, check_operator: bool) -> bool

Source

pub fn has_throw(&self, permission: Rights) -> Result<bool, &'static str>

Trait Implementations§

Source§

impl Binary for Rights

Source§

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

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

impl BitAnd for Rights

Source§

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

The bitwise and (&) of the bits in two flags values.

Source§

type Output = Rights

The resulting type after applying the & operator.
Source§

impl BitAndAssign for Rights

Source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

Source§

impl BitOr for Rights

Source§

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

The bitwise or (|) of the bits in two flags values.

Source§

type Output = Rights

The resulting type after applying the | operator.
Source§

impl BitOrAssign for Rights

Source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

Source§

impl BitXor for Rights

Source§

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

The bitwise exclusive-or (^) of the bits in two flags values.

Source§

type Output = Rights

The resulting type after applying the ^ operator.
Source§

impl BitXorAssign for Rights

Source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

Source§

impl Extend<Rights> for Rights

Source§

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

The bitwise or (|) of the bits in each flags value.

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 Flags for Rights

Source§

const FLAGS: &'static [Flag<Rights>]

The set of defined flags.
Source§

type Bits = u64

The underlying bits type.
Source§

fn bits(&self) -> u64

Get the underlying bits value. Read more
Source§

fn from_bits_retain(bits: u64) -> Rights

Convert from a bits value exactly.
Source§

fn empty() -> Self

Get a flags value with all bits unset.
Source§

fn all() -> Self

Get a flags value with all known bits set.
Source§

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.
Source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
Source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
Source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
Source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
Source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
Source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
Source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
Source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
Source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
Source§

fn truncate(&mut self)
where Self: Sized,

Remove any unknown bits from the flags.
Source§

fn insert(&mut self, other: Self)
where Self: Sized,

The bitwise or (|) of the bits in two flags values.
Source§

fn remove(&mut self, other: Self)
where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
Source§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
Source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
Source§

fn clear(&mut self)
where Self: Sized,

Unsets all bits in the flags.
Source§

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

The bitwise and (&) of the bits in two flags values.
Source§

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

The bitwise or (|) of the bits in two flags values.
Source§

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

The intersection of a source flags value with the complement of a target flags value (&!). Read more
Source§

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

The bitwise exclusive-or (^) of the bits in two flags values.
Source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
Source§

impl FromIterator<Rights> for Rights

Source§

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

The bitwise or (|) of the bits in each flags value.

Source§

impl IntoIterator for Rights

Source§

type Item = Rights

The type of the elements being iterated over.
Source§

type IntoIter = Iter<Rights>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl LowerHex for Rights

Source§

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

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

impl Not for Rights

Source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

Source§

type Output = Rights

The resulting type after applying the ! operator.
Source§

impl Octal for Rights

Source§

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

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

impl PublicFlags for Rights

Source§

type Primitive = u64

The type of the underlying storage.
Source§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
Source§

impl Sub for Rights

Source§

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

Source§

type Output = Rights

The resulting type after applying the - operator.
Source§

impl SubAssign for Rights

Source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

Source§

impl UpperHex for Rights

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Rights

§

impl RefUnwindSafe for Rights

§

impl Send for Rights

§

impl Sync for Rights

§

impl Unpin for Rights

§

impl UnwindSafe for Rights

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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, U> Into<U> for T
where 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.