Struct GatewayIntents

#[repr(packed(1))]
pub struct GatewayIntents(/* private fields */);

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, GatewayIntents::GUILD_MEMBERS and GatewayIntents::MESSAGE_CONTENT 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.

Discord docs.

Implementations

impl GatewayIntents

pub const GUILDS: Self

Enables the following gateway events:

• GUILD_CREATE
• GUILD_UPDATE
• 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

Info: The THREAD_MEMBERS_UPDATE event contains different data depending on which intents are used. See Discord’s Docs for more information.

pub const GUILD_MEMBERS: Self

Enables the 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, as well as enabling it in your code.

Info: The THREAD_MEMBERS_UPDATE event contains different data depending on which intents are used. See Discord’s Docs for more information.

pub const GUILD_MODERATION: Self

Enables the following gateway events:

• GUILD_AUDIT_LOG_ENTRY_CREATE
• GUILD_BAN_ADD
• GUILD_BAN_REMOVE

pub const GUILD_BANS: Self

👎Deprecated: Use [Self::GUILD_MODERATION] instead

Backwards compatibility with old gateway event name. Same as GUILD_MODERATION

pub const GUILD_EMOJIS_AND_STICKERS: Self

Enables the following gateway events:

• GUILD_EMOJIS_UPDATE
• GUILD_STICKERS_UPDATE

pub const GUILD_INTEGRATIONS: Self

Enables the following gateway events:

• GUILD_INTEGRATIONS_UPDATE
• INTEGRATION_CREATE
• INTEGRATION_UPDATE
• INTEGRATION_DELETE

pub const GUILD_WEBHOOKS: Self

Enables the following gateway event:

• WEBHOOKS_UPDATE

pub const GUILD_INVITES: Self

Enables the following gateway events:

• INVITE_CREATE
• INVITE_DELETE

pub const GUILD_VOICE_STATES: Self

Enables the following gateway event:

• VOICE_STATE_UPDATE

Note: this intent is mandatory for songbird to function properly.

pub const GUILD_PRESENCES: Self

Enables the 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, as well as enabling it in your code.

pub const GUILD_MESSAGES: Self

Enables the following gateway events in guilds:

• MESSAGE_CREATE
• MESSAGE_UPDATE
• MESSAGE_DELETE
• MESSAGE_DELETE_BULK

pub const GUILD_MESSAGE_REACTIONS: Self

Enables the following gateway events in guilds:

• 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

Enables the following gateway events for direct messages:

• MESSAGE_CREATE
• MESSAGE_UPDATE
• MESSAGE_DELETE
• CHANNEL_PINS_UPDATE

pub const DIRECT_MESSAGE_REACTIONS: Self

Enable following gateway events for direct messages:

• MESSAGE_REACTION_ADD
• MESSAGE_REACTION_REMOVE
• MESSAGE_REACTION_REMOVE_ALL
• MESSAGE_REACTION_REMOVE_EMOJI

pub const DIRECT_MESSAGE_TYPING: Self

Enables the following gateway events for direct messages:

• TYPING_START

pub const MESSAGE_CONTENT: Self

Enables receiving message content in gateway events

See Discord’s Docs for more information

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, as well as enabling it in your code.

pub const GUILD_SCHEDULED_EVENTS: Self

Enables the 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 AUTO_MODERATION_CONFIGURATION: Self

Enables the following gateway events:

• AUTO_MODERATION_RULE_CREATE
• AUTO_MODERATION_RULE_UPDATE
• AUTO_MODERATION_RULE_DELETE

pub const AUTO_MODERATION_EXECUTION: Self

Enables the following gateway events:

• AUTO_MODERATION_ACTION_EXECUTION

pub const GUILD_MESSAGE_POLLS: Self

Enables the following gateway events for guilds:

• MESSAGE_POLL_VOTE_ADD
• MESSAGE_POLL_VOTE_REMOVE

pub const DIRECT_MESSAGE_POLLS: Self

Enables the following gateway events for direct messages:

• MESSAGE_POLL_VOTE_ADD
• MESSAGE_POLL_VOTE_REMOVE

impl GatewayIntents

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

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

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.

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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.

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.

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

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

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.

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

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

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

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

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

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

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

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

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.

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

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

pub const fn complement(self) -> Self

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

impl GatewayIntents

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

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.

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

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.

impl GatewayIntents

pub const fn non_privileged() -> GatewayIntents

Gets all of the intents that aren’t 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.

impl GatewayIntents

pub const fn is_privileged(self) -> bool

Checks if any of the included intents are privileged.

pub const fn guilds(self) -> bool

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

pub const fn guild_members(self) -> bool

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

pub const fn guild_bans(self) -> bool

👎Deprecated: Use [Self::guild_moderation] instead

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

This is the same as calling guild_moderation since Discord changed the name

pub const fn guild_moderation(self) -> bool

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

pub const fn guild_emojis_and_stickers(self) -> bool

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

pub const fn guild_integrations(self) -> bool

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

pub const fn guild_webhooks(self) -> bool

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

pub const fn guild_invites(self) -> bool

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

pub const fn guild_voice_states(self) -> bool

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

pub const fn guild_presences(self) -> bool

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

pub const fn guild_message_reactions(self) -> bool

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

pub const fn guild_message_typing(self) -> bool

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

pub const fn direct_messages(self) -> bool

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

pub const fn direct_message_reactions(self) -> bool

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

pub const fn direct_message_typing(self) -> bool

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

pub const fn message_content(self) -> bool

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

pub const fn guild_scheduled_events(self) -> bool

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

pub const fn auto_moderation_configuration(self) -> bool

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

pub const fn auto_moderation_execution(self) -> bool

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

Trait Implementations

impl Binary for GatewayIntents

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

Formats the value using the given formatter.

impl BitAnd for GatewayIntents

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

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

type Output = GatewayIntents

The resulting type after applying the & operator.

impl BitAndAssign for GatewayIntents

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for GatewayIntents

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

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

type Output = GatewayIntents

The resulting type after applying the | operator.

impl BitOrAssign for GatewayIntents

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for GatewayIntents

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

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

type Output = GatewayIntents

The resulting type after applying the ^ operator.

impl BitXorAssign for GatewayIntents

fn bitxor_assign(&mut self, other: Self)

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

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)

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

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

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

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> GatewayIntents

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

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

Convert from a bits value.

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

Convert from a bits value, unsetting any unknown bits.

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

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

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

Yield a set of contained flags values.

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

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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.

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.

fn insert(&mut self, other: Self)

where Self: Sized,

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

fn remove(&mut self, other: Self)

where Self: Sized,

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

fn toggle(&mut self, other: Self)

where Self: Sized,

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

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.

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

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

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

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

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

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

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

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

fn complement(self) -> Self

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

impl FromIterator<GatewayIntents> for GatewayIntents

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

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

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for GatewayIntents

type Item = GatewayIntents

The type of the elements being iterated over.

type IntoIter = Iter<GatewayIntents>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

type Output = GatewayIntents

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 PartialEq for GatewayIntents

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GatewayIntents

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

Serialize this value into the given Serde serializer.

impl Sub for GatewayIntents

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.

type Output = GatewayIntents

The resulting type after applying the - operator.

impl SubAssign for GatewayIntents

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.

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 StructuralPartialEq for GatewayIntents