Struct serenity::client::bridge::gateway::GatewayIntents

pub struct GatewayIntents {
    pub bits: u64,
}

[Gateway Intents] will limit the events your bot will receive via the gateway. By default, all intents except Privileged Intents are selected.

What are Intents

A gateway intent sets the types of gateway events (e.g. member joins, guild integrations, guild emoji updates, …) the bot shall receive. Carefully picking the needed intents greatly helps the bot to scale, as less intents will result in less events to be received via the network from Discord and less processing needed for handling the data.

Privileged Intents

The intents GatewayIntents::GUILD_PRESENCES and GatewayIntents::GUILD_MEMBERS are Privileged Intents. They need to be enabled in the developer portal.

Note: Once the bot is in 100 guilds or more, the bot must be verified in order to use privileged intents.

Fields

bits: u64

The flags composing gateway intents.

Note

Do not modify this yourself; use the provided methods. Do the same when creating, unless you’re absolutely certain that you’re giving valid intents flags.

Implementations

impl GatewayIntents

pub const GUILDS: Self

Enables following gateway events:

• GUILD_CREATE
• GUILD_DELETE
• GUILD_ROLE_CREATE
• GUILD_ROLE_UPDATE
• GUILD_ROLE_DELETE
• CHANNEL_CREATE
• CHANNEL_UPDATE
• CHANNEL_DELETE
• CHANNEL_PINS_UPDATE
• THREAD_CREATE
• THREAD_UPDATE
• THREAD_DELETE
• THREAD_LIST_SYNC
• THREAD_MEMBER_UPDATE
• THREAD_MEMBERS_UPDATE
• STAGE_INSTANCE_CREATE
• STAGE_INSTANCE_UPDATE
• STAGE_INSTANCE_DELETE

pub const GUILD_MEMBERS: Self

Enables following gateway events:

• GUILD_MEMBER_ADD
• GUILD_MEMBER_UPDATE
• GUILD_MEMBER_REMOVE
• THREAD_MEMBERS_UPDATE

Info: This intent is privileged. In order to use it, you must head to your application in the Developer Portal and enable the toggle for Privileged Intents.

This intent is also necessary to even receive the events in contains.

pub const GUILD_BANS: Self

Enables following gateway events:

• GUILD_BAN_ADD
• GUILD_BAN_REMOVE

pub const GUILD_EMOJIS: Self

Enables following gateway event:

• GUILD_EMOJIS_UPDATE

pub const GUILD_INTEGRATIONS: Self

Enables following gateway event:

• GUILD_INTEGRATIONS_UPDATE
• INTEGRATION_CREATE
• INTEGRATION_UPDATE
• INTEGRATION_DELETE

pub const GUILD_WEBHOOKS: Self

Enables following gateway event:

• WEBHOOKS_UPDATE

pub const GUILD_INVITES: Self

Enables following gateway events:

• INVITE_CREATE
• INVITE_DELETE

pub const GUILD_VOICE_STATES: Self

Enables following gateway event:

• VOICE_STATE_UPDATE

pub const GUILD_PRESENCES: Self

Enables following gateway event:

• PRESENCE_UPDATE

Info: This intent is privileged. In order to use it, you must head to your application in the Developer Portal and enable the toggle for Privileged Intents.

This intent is also necessary to even receive the events in contains.

pub const GUILD_MESSAGES: Self

Enables following gateway events:

• MESSAGE_CREATE
• MESSAGE_UPDATE
• MESSAGE_DELETE
• MESSAGE_DELETE_BULK

pub const GUILD_MESSAGE_REACTIONS: Self

Enables following gateway events:

• MESSAGE_REACTION_ADD
• MESSAGE_REACTION_REMOVE
• MESSAGE_REACTION_REMOVE_ALL
• MESSAGE_REACTION_REMOVE_EMOJI

pub const GUILD_MESSAGE_TYPING: Self

Enable following gateway event:

• TYPING_START

pub const DIRECT_MESSAGES: Self

Enable following gateway events:

• MESSAGE_CREATE
• MESSAGE_UPDATE
• MESSAGE_DELETE
• CHANNEL_PINS_UPDATE

pub const DIRECT_MESSAGE_REACTIONS: Self

Enable following gateway events:

• MESSAGE_REACTION_ADD
• MESSAGE_REACTION_REMOVE
• MESSAGE_REACTION_REMOVE_ALL
• MESSAGE_REACTION_REMOVE_EMOJI

pub const DIRECT_MESSAGE_TYPING: Self

Enable following gateway event:

• TYPING_START

pub const GUILD_SCHEDULED_EVENTS: Self

Enable following gateway events:

• GUILD_SCHEDULED_EVENT_CREATE
• GUILD_SCHEDULED_EVENT_UPDATE
• GUILD_SCHEDULED_EVENT_DELETE
• GUILD_SCHEDULED_EVENT_USER_ADD
• GUILD_SCHEDULED_EVENT_USER_REMOVE

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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.

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

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

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.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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.

impl GatewayIntents

pub const fn non_privileged() -> GatewayIntents

Gets all of the intents that don’t are considered privileged by Discord.

pub const fn privileged() -> GatewayIntents

Gets all of the intents that are considered privileged by Discord. Use of these intents will require explicitly whitelisting the bot.

pub fn is_privileged(self) -> bool

Checks if any of the included intents are privileged

pub fn guilds(self) -> bool

Shorthand for checking that the set of intents contains the GUILDS intent.

pub fn guild_members(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_MEMBERS intent.

pub fn guild_bans(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_BANS intent.

pub fn guild_emojis(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_EMOJIS intent.

pub fn guild_integrations(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_INTEGRATIONS intent.

pub fn guild_webhooks(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_WEBHOOKS intent.

pub fn guild_invites(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_INVITES intent.

pub fn guild_voice_states(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_VOICE_STATES intent.

pub fn guild_presences(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_PRESENCES intent.

pub fn guild_message_reactions(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_MESSAGE_REACTIONS intent.

pub fn guild_message_typing(self) -> bool

Shorthand for checking that the set of intents contains the GUILD_MESSAGE_TYPING intent.

pub fn direct_messages(self) -> bool

Shorthand for checking that the set of intents contains the DIRECT_MESSAGES intent.

pub fn direct_message_reactions(self) -> bool

Shorthand for checking that the set of intents contains the DIRECT_MESSAGE_REACTIONS intent.

pub fn direct_message_typing(self) -> bool

Shorthand for checking that the set of intents contains the DIRECT_MESSAGE_TYPING intent.

Trait Implementations

impl Binary for GatewayIntents

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

Formats the value using the given formatter.

impl BitAnd<GatewayIntents> for GatewayIntents

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

Returns the intersection between the two sets of flags.

type Output = Self

The resulting type after applying the & operator.

impl BitAndAssign<GatewayIntents> for GatewayIntents

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<GatewayIntents> for GatewayIntents

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

Returns the union of the two sets of flags.

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<GatewayIntents> for GatewayIntents

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<GatewayIntents> for GatewayIntents

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

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

type Output = Self

The resulting type after applying the ^ operator.

impl BitXorAssign<GatewayIntents> for GatewayIntents

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for GatewayIntents

fn clone(&self) -> GatewayIntents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GatewayIntents

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

Formats the value using the given formatter.

impl Default for GatewayIntents

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GatewayIntents

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

Deserialize this value from the given Serde deserializer.

impl Extend<GatewayIntents> for GatewayIntents

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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.

impl FromIterator<GatewayIntents> for GatewayIntents

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

Creates a value from an iterator.

impl Hash for GatewayIntents

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 GatewayIntents

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

Formats the value using the given formatter.

impl Not for GatewayIntents

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Self

The resulting type after applying the ! operator.

impl Octal for GatewayIntents

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

Formats the value using the given formatter.

impl Ord for GatewayIntents

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<GatewayIntents> for GatewayIntents

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

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

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

This method tests for !=.

impl PartialOrd<GatewayIntents> for GatewayIntents

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

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

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

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

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

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

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

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

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

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

impl Serialize for GatewayIntents

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

Serialize this value into the given Serde serializer.

impl Sub<GatewayIntents> for GatewayIntents

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

Returns the set difference of the two sets of flags.

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<GatewayIntents> for GatewayIntents

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for GatewayIntents

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

Formats the value using the given formatter.

impl Copy for GatewayIntents

impl Eq for GatewayIntents

impl StructuralEq for GatewayIntents

impl StructuralPartialEq for GatewayIntents