Struct twilight_gateway::Intents

pub struct Intents { /* fields omitted */ }

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 the discord docs for more information.

Implementations

impl Intents

pub const GUILDS: Intents

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

pub const GUILD_MEMBERS: Intents

Guild members intent.

This intent is privileged. See the discord docs for more information.

Event(s) received:

• GUILD_MEMBER_ADD
• GUILD_MEMBER_UPDATE
• GUILD_MEMBER_REMOVE

pub const GUILD_BANS: Intents

Guild bans intent.

Event(s) received:

• GUILD_BAN_ADD
• GUILD_BAN_REMOVE

pub const GUILD_EMOJIS: Intents

Guild emojis intent.

Event(s) received:

• GUILD_EMOJIS_UPDATE

pub const GUILD_INTEGRATIONS: Intents

Guild integrations intent.

Event(s) received:

• GUILD_INTEGRATIONS_UPDATE

pub const GUILD_WEBHOOKS: Intents

Guild webhooks intent.

Event(s) received:

• WEBHOOKS_UPDATE

pub const GUILD_INVITES: Intents

Guild invites intent.

Event(s) received:

• INVITE_CREATE
• INVITE_DELETE

pub const GUILD_VOICE_STATES: Intents

Guild voice states intent.

Event(s) received:

• VOICE_STATE_UPDATE

pub const GUILD_PRESENCES: Intents

Guild presences intent.

This intent is privileged. See the discord docs for more information.

Event(s) received:

• PRESENCE_UPDATE

pub const GUILD_MESSAGES: Intents

Guild messages intent.

Event(s) received:

• MESSAGE_CREATE
• MESSAGE_UPDATE
• MESSAGE_DELETE
• MESSAGE_DELETE_BULK

pub const GUILD_MESSAGE_REACTIONS: Intents

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

Guild message typing intent.

Event(s) received:

• TYPING_START

pub const DIRECT_MESSAGES: Intents

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

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

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 fn empty() -> Intents

Returns an empty set of flags

pub const fn all() -> Intents

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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

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

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

pub const unsafe fn from_bits_unchecked(bits: u64) -> Intents

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Intents

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

Formats the value using the given formatter.

impl BitAnd<Intents> for Intents

type Output = Intents

The resulting type after applying the & operator.

pub fn bitand(self, other: Intents) -> Intents

Returns the intersection between the two sets of flags.

impl BitAndAssign<Intents> for Intents

pub fn bitand_assign(&mut self, other: Intents)

Disables all flags disabled in the set.

impl BitOr<Intents> for Intents

type Output = Intents

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Intents> for Intents

pub fn bitor_assign(&mut self, other: Intents)

Adds the set of flags.

impl BitXor<Intents> for Intents

type Output = Intents

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: Intents) -> Intents

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

impl BitXorAssign<Intents> for Intents

pub fn bitxor_assign(&mut self, other: Intents)

Toggles the set of flags.

impl Clone for Intents

pub fn clone(&self) -> Intents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Intents

impl Debug for Intents

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Eq for Intents

impl Extend<Intents> for Intents

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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

pub fn from_iter<T>(iterator: T) -> Intents where
    T: IntoIterator<Item = Intents>, 

Creates a value from an iterator.

impl Hash for Intents

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

Feeds this value into the given Hasher.

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

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

Formats the value using the given formatter.

impl Not for Intents

type Output = Intents

The resulting type after applying the ! operator.

pub fn not(self) -> Intents

Returns the complement of this set of flags.

impl Octal for Intents

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

Formats the value using the given formatter.

impl Ord for Intents

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Intents> for Intents

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

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

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

This method tests for !=.

impl PartialOrd<Intents> for Intents

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

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

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

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

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

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

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

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

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

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

impl Serialize for Intents

pub 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.

impl StructuralEq for Intents

impl StructuralPartialEq for Intents

impl Sub<Intents> for Intents

type Output = Intents

The resulting type after applying the - operator.

pub fn sub(self, other: Intents) -> Intents

Returns the set difference of the two sets of flags.

impl SubAssign<Intents> for Intents

pub fn sub_assign(&mut self, other: Intents)

Disables all flags enabled in the set.

impl UpperHex for Intents

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

Formats the value using the given formatter.