Struct twilight_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: 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
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: Intents = _
pub const GUILD_MEMBERS: Intents = _
Guild members intent.
This intent is privileged. See Discord Docs/Privileged Intents.
Event(s) received:
sourcepub const GUILD_BANS: Intents = _
👎Deprecated since 0.14.3: use the GUILD_MODERATION
intent instead
pub const GUILD_BANS: Intents = _
GUILD_MODERATION
intent insteadsourcepub const GUILD_MODERATION: Intents = _
pub const GUILD_MODERATION: Intents = _
Guild moderation intent.
Event(s) received:
sourcepub const GUILD_EMOJIS_AND_STICKERS: Intents = _
pub const GUILD_EMOJIS_AND_STICKERS: Intents = _
sourcepub const GUILD_INTEGRATIONS: Intents = _
pub const GUILD_INTEGRATIONS: Intents = _
Guild integrations intent.
Event(s) received:
sourcepub const GUILD_WEBHOOKS: Intents = _
pub const GUILD_WEBHOOKS: Intents = _
sourcepub const GUILD_INVITES: Intents = _
pub const GUILD_INVITES: Intents = _
sourcepub const GUILD_VOICE_STATES: Intents = _
pub const GUILD_VOICE_STATES: Intents = _
sourcepub const GUILD_PRESENCES: Intents = _
pub const GUILD_PRESENCES: Intents = _
Guild presences intent.
This intent is privileged. See Discord Docs/Privileged Intents.
Event(s) received:
sourcepub const GUILD_MESSAGES: Intents = _
pub const GUILD_MESSAGES: Intents = _
Guild messages intent.
Event(s) received:
sourcepub const GUILD_MESSAGE_REACTIONS: Intents = _
pub const GUILD_MESSAGE_REACTIONS: Intents = _
Guild message reactions intent.
Event(s) received:
sourcepub const GUILD_MESSAGE_TYPING: Intents = _
pub const GUILD_MESSAGE_TYPING: Intents = _
sourcepub const DIRECT_MESSAGES: Intents = _
pub const DIRECT_MESSAGES: Intents = _
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: Intents = _
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.
sourcepub const DIRECT_MESSAGE_TYPING: Intents = _
pub const DIRECT_MESSAGE_TYPING: Intents = _
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: Intents = _
pub const MESSAGE_CONTENT: Intents = _
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: Intents = _
pub const GUILD_SCHEDULED_EVENTS: Intents = _
Guild scheduled events intent.
Event(s) received:
sourcepub const AUTO_MODERATION_CONFIGURATION: Intents = _
pub const AUTO_MODERATION_CONFIGURATION: Intents = _
Auto moderation configuration intent.
Event(s) received:
sourcepub const AUTO_MODERATION_EXECUTION: Intents = _
pub const AUTO_MODERATION_EXECUTION: Intents = _
sourcepub const fn from_bits(bits: u64) -> Option<Intents>
pub const fn from_bits(bits: u64) -> Option<Intents>
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) -> Intents
pub const fn from_bits_truncate(bits: u64) -> Intents
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Intents
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).
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: Intents) -> bool
pub const fn intersects(&self, other: Intents) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Intents) -> bool
pub const fn contains(&self, other: Intents) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Intents, value: bool)
pub fn set(&mut self, other: Intents, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Intents) -> Intents
pub const fn intersection(self, other: Intents) -> Intents
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: Intents) -> Intents
pub const fn union(self, other: Intents) -> Intents
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: Intents) -> Intents
pub const fn difference(self, other: Intents) -> Intents
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: Intents) -> Intents
pub const fn symmetric_difference(self, other: Intents) -> Intents
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) -> Intents
pub const fn complement(self) -> Intents
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: Intents)
fn bitand_assign(&mut self, other: Intents)
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: Intents)
fn bitor_assign(&mut self, other: Intents)
Adds the set of flags.
source§impl BitXorAssign<Intents> for Intents
impl BitXorAssign<Intents> for Intents
source§fn bitxor_assign(&mut self, other: Intents)
fn bitxor_assign(&mut self, other: Intents)
Toggles the set of flags.
source§impl<'de> Deserialize<'de> for Intents
impl<'de> Deserialize<'de> for Intents
source§fn deserialize<D>(
deserializer: D
) -> Result<Intents, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>( deserializer: D ) -> Result<Intents, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,
source§impl Extend<Intents> for Intents
impl Extend<Intents> for Intents
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Intents>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = Intents>,
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§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 Serialize for Intents
impl Serialize for Intents
source§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,
source§impl SubAssign<Intents> for Intents
impl SubAssign<Intents> for Intents
source§fn sub_assign(&mut self, other: Intents)
fn sub_assign(&mut self, other: Intents)
Disables all flags enabled in the set.
impl Copy for Intents
impl Eq for Intents
impl StructuralEq for Intents
impl StructuralPartialEq for Intents
Auto Trait Implementations§
impl RefUnwindSafe for Intents
impl Send for Intents
impl Sync for Intents
impl Unpin for Intents
impl UnwindSafe for Intents
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.