Struct Intents

pub struct Intents(/* private fields */);

Gateway intents.

Developers must specify intents when connecting to the gateway. The intents specified correspond with the events received. To specify multiple intents, create a union using the | operator. See Discord Docs/Gateway Intents.

Implementations

impl Intents

pub const GUILDS: Self = _

Guilds intent.

Event(s) received:

• 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

pub const GUILD_MEMBERS: Self = _

Guild members intent.

This intent is privileged. See Discord Docs/Privileged Intents.

Event(s) received:

• GUILD_MEMBER_ADD
• GUILD_MEMBER_UPDATE
• GUILD_MEMBER_REMOVE
• THREAD_MEMBERS_UPDATE

pub const GUILD_MODERATION: Self = _

Guild moderation intent.

Event(s) received:

• GUILD_AUDIT_LOG_ENTRY_CREATE
• GUILD_BAN_ADD
• GUILD_BAN_REMOVE

pub const GUILD_EMOJIS_AND_STICKERS: Self = _

Guild emojis and stickers intent.

Event(s) received:

• GUILD_EMOJIS_UPDATE
• GUILD_STICKERS_UPDATE

pub const GUILD_INTEGRATIONS: Self = _

Guild integrations intent.

Event(s) received:

• GUILD_INTEGRATIONS_UPDATE
• INTEGRATION_CREATE
• INTEGRATION_UPDATE
• INTEGRATION_DELETE

pub const GUILD_WEBHOOKS: Self = _

Guild webhooks intent.

Event(s) received:

• WEBHOOKS_UPDATE

pub const GUILD_INVITES: Self = _

Guild invites intent.

Event(s) received:

• INVITE_CREATE
• INVITE_DELETE

pub const GUILD_VOICE_STATES: Self = _

Guild voice states intent.

Event(s) received:

• VOICE_STATE_UPDATE

pub const GUILD_PRESENCES: Self = _

Guild presences intent.

This intent is privileged. See Discord Docs/Privileged Intents.

Event(s) received:

• PRESENCE_UPDATE

pub const GUILD_MESSAGES: Self = _

Guild messages intent.

Event(s) received:

• MESSAGE_CREATE
• MESSAGE_UPDATE
• MESSAGE_DELETE
• MESSAGE_DELETE_BULK

pub const GUILD_MESSAGE_REACTIONS: Self = _

Guild message reactions intent.

Event(s) received:

• MESSAGE_REACTION_ADD
• MESSAGE_REACTION_REMOVE
• MESSAGE_REACTION_REMOVE_ALL
• MESSAGE_REACTION_REMOVE_EMOJI

pub const GUILD_MESSAGE_TYPING: Self = _

Guild message typing intent.

Event(s) received:

• TYPING_START

pub const DIRECT_MESSAGES: Self = _

Direct messages intent.

Event(s) received:

• MESSAGE_CREATE
• MESSAGE_UPDATE
• MESSAGE_DELETE
• MESSAGE_DELETE_BULK

This is different from the GUILD_MESSAGES intent in that the bot will receive message events from locations other than guilds.

pub const DIRECT_MESSAGE_REACTIONS: Self = _

Direct message reactions intent.

Event(s) received:

• MESSAGE_REACTION_ADD
• MESSAGE_REACTION_REMOVE
• MESSAGE_REACTION_REMOVE_ALL
• MESSAGE_REACTION_REMOVE_EMOJI

This is different from the GUILD_MESSAGE_REACTIONS event in that the bot will receive message reaction events from locations other than guilds.

pub const DIRECT_MESSAGE_TYPING: Self = _

Direct message typing intent.

Event(s) received:

• TYPING_START

This is different from the GUILD_MESSAGE_TYPING intent in that the bot will receive typing start events from locations other than guilds.

pub const MESSAGE_CONTENT: Self = _

Message content intent.

This intent is privileged. See Discord Docs/Privileged Intents.

This intent allows you to receive the contents of all messages.

pub const GUILD_SCHEDULED_EVENTS: Self = _

Guild scheduled events intent.

Event(s) received:

• 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 = _

Auto moderation configuration intent.

Event(s) received:

• AUTO_MODERATION_RULE_CREATE
• AUTO_MODERATION_RULE_DELETE
• AUTO_MODERATION_RULE_UPDATE

pub const AUTO_MODERATION_EXECUTION: Self = _

Auto moderation execution event.

Event(s) received:

• AUTO_MODERATION_ACTION_EXECUTION

pub const GUILD_MESSAGE_POLLS: Self = _

Guild polls intent.

Event(s) received:

• MESSAGE_POLL_VOTE_ADD
• MESSAGE_POLL_VOTE_REMOVE

pub const DIRECT_MESSAGE_POLLS: Self = _

Direct message polls intent.

Event(s) received:

• MESSAGE_POLL_VOTE_ADD
• MESSAGE_POLL_VOTE_REMOVE

impl Intents

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 Intents

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

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<Intents>

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.

Trait Implementations

impl Binary for Intents

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

Formats the value using the given formatter.

impl BitAnd for Intents

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

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

type Output = Intents

The resulting type after applying the & operator.

impl BitAndAssign for Intents

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for Intents

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

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

type Output = Intents

The resulting type after applying the | operator.

impl BitOrAssign for Intents

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for Intents

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

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

type Output = Intents

The resulting type after applying the ^ operator.

impl BitXorAssign for Intents

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for Intents

fn clone(&self) -> Intents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Intents

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Intents

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

Deserialize this value from the given Serde deserializer.

impl Extend<Intents> for Intents

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 Intents

const FLAGS: &'static [Flag<Intents>] = _

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) -> Intents

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<Intents> for Intents

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

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

impl Hash for Intents

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 Intents

type Item = Intents

The type of the elements being iterated over.

type IntoIter = Iter<Intents>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Intents

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

Formats the value using the given formatter.

impl Not for Intents

fn not(self) -> Self

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

type Output = Intents

The resulting type after applying the ! operator.

impl Octal for Intents

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

Formats the value using the given formatter.

impl PartialEq for Intents

fn eq(&self, other: &Intents) -> 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 PublicFlags for Intents

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Serialize for Intents

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Intents

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 = Intents

The resulting type after applying the - operator.

impl SubAssign for Intents

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 Intents

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

Formats the value using the given formatter.

impl Copy for Intents

impl Eq for Intents

impl StructuralPartialEq for Intents