Struct twilight_model::gateway::Intents
source · pub struct Intents { /* private fields */ }
Expand description
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§
source§impl Intents
impl Intents
sourcepub const GUILDS: Self = _
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
sourcepub const GUILD_MEMBERS: Self = _
pub const GUILD_MEMBERS: Self = _
Guild members intent.
This intent is privileged. See Discord Docs/Privileged Intents.
Event(s) received:
sourcepub const GUILD_BANS: Self = _
👎Deprecated since 0.14.3: use the GUILD_MODERATION
intent instead
pub const GUILD_BANS: Self = _
GUILD_MODERATION
intent insteadsourcepub const GUILD_MODERATION: Self = _
pub const GUILD_MODERATION: Self = _
Guild moderation intent.
Event(s) received:
sourcepub const GUILD_EMOJIS_AND_STICKERS: Self = _
pub const GUILD_EMOJIS_AND_STICKERS: Self = _
sourcepub const GUILD_INTEGRATIONS: Self = _
pub const GUILD_INTEGRATIONS: Self = _
Guild integrations intent.
Event(s) received:
sourcepub const GUILD_WEBHOOKS: Self = _
pub const GUILD_WEBHOOKS: Self = _
sourcepub const GUILD_INVITES: Self = _
pub const GUILD_INVITES: Self = _
sourcepub const GUILD_VOICE_STATES: Self = _
pub const GUILD_VOICE_STATES: Self = _
sourcepub const GUILD_PRESENCES: Self = _
pub const GUILD_PRESENCES: Self = _
Guild presences intent.
This intent is privileged. See Discord Docs/Privileged Intents.
Event(s) received:
sourcepub const GUILD_MESSAGES: Self = _
pub const GUILD_MESSAGES: Self = _
Guild messages intent.
Event(s) received:
sourcepub const GUILD_MESSAGE_REACTIONS: Self = _
pub const GUILD_MESSAGE_REACTIONS: Self = _
Guild message reactions intent.
Event(s) received:
sourcepub const GUILD_MESSAGE_TYPING: Self = _
pub const GUILD_MESSAGE_TYPING: Self = _
sourcepub const DIRECT_MESSAGES: Self = _
pub const DIRECT_MESSAGES: Self = _
Direct messages intent.
Event(s) received:
This is different from the GUILD_MESSAGES
intent in that the bot
will receive message events from locations other than guilds.
sourcepub const DIRECT_MESSAGE_REACTIONS: Self = _
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.
sourcepub const DIRECT_MESSAGE_TYPING: Self = _
pub const DIRECT_MESSAGE_TYPING: Self = _
Direct message typing intent.
Event(s) received:
This is different from the GUILD_MESSAGE_TYPING
intent in that
the bot will receive typing start events from locations other than
guilds.
sourcepub const MESSAGE_CONTENT: Self = _
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.
sourcepub const GUILD_SCHEDULED_EVENTS: Self = _
pub const GUILD_SCHEDULED_EVENTS: Self = _
Guild scheduled events intent.
Event(s) received:
sourcepub const AUTO_MODERATION_CONFIGURATION: Self = _
pub const AUTO_MODERATION_CONFIGURATION: Self = _
Auto moderation configuration intent.
Event(s) received:
sourcepub const AUTO_MODERATION_EXECUTION: Self = _
pub const AUTO_MODERATION_EXECUTION: Self = _
sourcepub const fn from_bits(bits: u64) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
.
Trait Implementations§
source§impl BitAndAssign<Intents> for Intents
impl BitAndAssign<Intents> for Intents
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign<Intents> for Intents
impl BitOrAssign<Intents> for Intents
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<Intents> for Intents
impl BitXorAssign<Intents> for Intents
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl<'de> Deserialize<'de> for Intents
impl<'de> Deserialize<'de> for Intents
source§fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
source§impl Extend<Intents> for Intents
impl Extend<Intents> for Intents
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<Intents> for Intents
impl FromIterator<Intents> for Intents
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for Intents
impl Ord for Intents
source§impl PartialEq<Intents> for Intents
impl PartialEq<Intents> for Intents
source§impl PartialOrd<Intents> for Intents
impl PartialOrd<Intents> for Intents
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign<Intents> for Intents
impl SubAssign<Intents> for Intents
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.