Struct twilight_gateway::Intents
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§
§impl Intents
impl Intents
pub 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
pub const GUILD_MEMBERS: Intents = _
pub const GUILD_MEMBERS: Intents = _
Guild members intent.
This intent is privileged. See Discord Docs/Privileged Intents.
Event(s) received:
pub const GUILD_MODERATION: Intents = _
pub const GUILD_MODERATION: Intents = _
Guild moderation intent.
Event(s) received:
pub const GUILD_EMOJIS_AND_STICKERS: Intents = _
pub const GUILD_EMOJIS_AND_STICKERS: Intents = _
pub const GUILD_INTEGRATIONS: Intents = _
pub const GUILD_INTEGRATIONS: Intents = _
Guild integrations intent.
Event(s) received:
pub const GUILD_WEBHOOKS: Intents = _
pub const GUILD_WEBHOOKS: Intents = _
pub const GUILD_INVITES: Intents = _
pub const GUILD_INVITES: Intents = _
pub const GUILD_VOICE_STATES: Intents = _
pub const GUILD_VOICE_STATES: Intents = _
pub const GUILD_PRESENCES: Intents = _
pub const GUILD_PRESENCES: Intents = _
Guild presences intent.
This intent is privileged. See Discord Docs/Privileged Intents.
Event(s) received:
pub const GUILD_MESSAGES: Intents = _
pub const GUILD_MESSAGES: Intents = _
Guild messages intent.
Event(s) received:
pub const GUILD_MESSAGE_REACTIONS: Intents = _
pub const GUILD_MESSAGE_REACTIONS: Intents = _
Guild message reactions intent.
Event(s) received:
pub const GUILD_MESSAGE_TYPING: Intents = _
pub const GUILD_MESSAGE_TYPING: Intents = _
pub 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.
pub 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.
pub 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.
pub 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.
pub const GUILD_SCHEDULED_EVENTS: Intents = _
pub const GUILD_SCHEDULED_EVENTS: Intents = _
Guild scheduled events intent.
Event(s) received:
pub const AUTO_MODERATION_CONFIGURATION: Intents = _
pub const AUTO_MODERATION_CONFIGURATION: Intents = _
Auto moderation configuration intent.
Event(s) received:
pub const AUTO_MODERATION_EXECUTION: Intents = _
pub const AUTO_MODERATION_EXECUTION: Intents = _
§impl Intents
impl Intents
pub const fn bits(&self) -> u64
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<Intents>
pub const fn from_bits(bits: u64) -> Option<Intents>
Convert from a bits value.
This method will return None
if any unknown bits are set.
pub const fn from_bits_truncate(bits: u64) -> Intents
pub const fn from_bits_truncate(bits: u64) -> Intents
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u64) -> Intents
pub const fn from_bits_retain(bits: u64) -> Intents
Convert from a bits value exactly.
pub fn from_name(name: &str) -> Option<Intents>
pub fn from_name(name: &str) -> Option<Intents>
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 intersects(&self, other: Intents) -> bool
pub const fn intersects(&self, other: Intents) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
pub const fn contains(&self, other: Intents) -> bool
pub const fn contains(&self, other: Intents) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
pub fn remove(&mut self, other: Intents)
pub fn remove(&mut self, other: Intents)
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: Intents)
pub fn toggle(&mut self, other: Intents)
The bitwise exclusive-or (^
) of the bits in two flags values.
pub fn set(&mut self, other: Intents, value: bool)
pub fn set(&mut self, other: Intents, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
pub const fn intersection(self, other: Intents) -> Intents
pub const fn intersection(self, other: Intents) -> Intents
The bitwise and (&
) of the bits in two flags values.
pub const fn union(self, other: Intents) -> Intents
pub const fn union(self, other: Intents) -> Intents
The bitwise or (|
) of the bits in two flags values.
pub const fn difference(self, other: Intents) -> Intents
pub const fn difference(self, other: Intents) -> Intents
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: Intents) -> Intents
pub const fn symmetric_difference(self, other: Intents) -> Intents
The bitwise exclusive-or (^
) of the bits in two flags values.
pub const fn complement(self) -> Intents
pub const fn complement(self) -> Intents
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§impl Intents
impl Intents
pub const fn iter(&self) -> Iter<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>
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 BitAndAssign for Intents
impl BitAndAssign for Intents
§fn bitand_assign(&mut self, other: Intents)
fn bitand_assign(&mut self, other: Intents)
The bitwise and (&
) of the bits in two flags values.
§impl BitOrAssign for Intents
impl BitOrAssign for Intents
§fn bitor_assign(&mut self, other: Intents)
fn bitor_assign(&mut self, other: Intents)
The bitwise or (|
) of the bits in two flags values.
§impl BitXorAssign for Intents
impl BitXorAssign for Intents
§fn bitxor_assign(&mut self, other: Intents)
fn bitxor_assign(&mut self, other: Intents)
The bitwise exclusive-or (^
) of the bits in two flags values.
§impl<'de> Deserialize<'de> for Intents
impl<'de> Deserialize<'de> for Intents
§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>,
§impl Extend<Intents> for Intents
impl Extend<Intents> for Intents
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Intents>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Intents>,
The bitwise or (|
) of the bits in each flags value.
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
)§impl Flags for Intents
impl Flags for Intents
§fn from_bits_retain(bits: u64) -> Intents
fn from_bits_retain(bits: u64) -> Intents
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.§impl FromIterator<Intents> for Intents
impl FromIterator<Intents> for Intents
§fn from_iter<T>(iterator: T) -> Intentswhere
T: IntoIterator<Item = Intents>,
fn from_iter<T>(iterator: T) -> Intentswhere
T: IntoIterator<Item = Intents>,
The bitwise or (|
) of the bits in each flags value.
§impl IntoIterator for Intents
impl IntoIterator for Intents
§impl Serialize for Intents
impl Serialize for Intents
§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,
§impl Sub for Intents
impl Sub for Intents
§impl SubAssign for Intents
impl SubAssign for Intents
§fn sub_assign(&mut self, other: Intents)
fn sub_assign(&mut self, other: Intents)
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 Copy for Intents
impl Eq for Intents
impl StructuralPartialEq for Intents
Auto Trait Implementations§
impl Freeze for Intents
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
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.