Struct EventTypeFlags

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

Important optimization for narrowing requested event types.

Specifying event types is an important optimization technique on top of Intents, which can dramatically decrease processor usage in many circumstances. While specifying intents are required by Discord and allow filtering groups of Events, event type flags are a Twilight-specific technique to filter out individual events from being deserialized at all, effectively discarding them.

For example, Intents::GUILDS includes a wide range of events from GuildCreate to RoleUpdate to ChannelPinsUpdate. If the only events used in this group of events is, say, ChannelCreate and RoleCreate, then the CHANNEL_CREATE and ROLE_CREATE event type flags can be specified in combination with that intent to only deserialize those events.

Selected event types only affect the events returned by Shards. Events necessary for maintaining the connection to Discord, such as GATEWAY_HEARTBEAT and GATEWAY_HELLO, can safely be excluded and won’t cause the operation of shards to fail, because shards will always parse portions of necessary events.

Implementations

impl EventTypeFlags

pub const AUTO_MODERATION_ACTION_EXECUTION: Self

Message has been blocked by AutoMod according to a rule.

pub const AUTO_MODERATION_RULE_CREATE: Self

AutoModerationRule has been created.

pub const AUTO_MODERATION_RULE_DELETE: Self

AutoModerationRule has been deleted.

pub const AUTO_MODERATION_RULE_UPDATE: Self

AutoModerationRule has been updated.

pub const ENTITLEMENT_CREATE: Self

An entitlement has been created.

pub const ENTITLEMENT_DELETE: Self

An entitlement has been deleted.

pub const ENTITLEMENT_UPDATE: Self

An entitlement has been updated.

pub const BAN_ADD: Self

User has been banned from a guild.

pub const BAN_REMOVE: Self

User has been unbanned from a guild.

pub const CHANNEL_CREATE: Self

Channel has been created.

pub const CHANNEL_DELETE: Self

Channel has been deleted.

pub const CHANNEL_PINS_UPDATE: Self

Channel’s pins have been updated.

pub const CHANNEL_UPDATE: Self

Channel has been updated.

pub const COMMAND_PERMISSIONS_UPDATE: Self

A command’s permissions has been updated.

pub const GATEWAY_HEARTBEAT: Self

Heartbeat has been created.

pub const GATEWAY_HEARTBEAT_ACK: Self

Heartbeat has been acknowledged.

pub const GATEWAY_HELLO: Self

A “hello” packet has been received from the gateway.

pub const GATEWAY_INVALIDATE_SESSION: Self

Shard’s session has been invalidated.

A payload containing a boolean is included. If true the session is resumable. If not, then the shard must initialize a new session.

pub const GATEWAY_RECONNECT: Self

Gateway is indicating that a shard should perform a reconnect.

pub const GUILD_AUDIT_LOG_ENTRY_CREATE: Self

An audit log entry has been created.

pub const GUILD_CREATE: Self

A guild has been created.

pub const GUILD_DELETE: Self

A guild has been deleted or the current user has been removed from a guild.

pub const GUILD_EMOJIS_UPDATE: Self

A guild’s emojis have been updated.

pub const GUILD_INTEGRATIONS_UPDATE: Self

A guild’s integrations have been updated.

pub const GUILD_SCHEDULED_EVENT_CREATE: Self

A guild’s integrations have been updated.

pub const GUILD_SCHEDULED_EVENT_DELETE: Self

A guild’s integrations have been updated.

pub const GUILD_SCHEDULED_EVENT_UPDATE: Self

A guild’s integrations have been updated.

pub const GUILD_SCHEDULED_EVENT_USER_ADD: Self

A guild’s integrations have been updated.

pub const GUILD_SCHEDULED_EVENT_USER_REMOVE: Self

A guild’s integrations have been updated.

pub const GUILD_STICKERS_UPDATE: Self

A guild’s stickers have been updated.

pub const GUILD_UPDATE: Self

A guild has been updated.

pub const INTEGRATION_CREATE: Self

A guild integration was created.

pub const INTEGRATION_DELETE: Self

A guild integration was deleted.

pub const INTEGRATION_UPDATE: Self

A guild integration was updated.

pub const INTERACTION_CREATE: Self

An interaction was invoked by a user.

pub const INVITE_CREATE: Self

Invite for a channel has been created.

pub const INVITE_DELETE: Self

Invite for a channel has been deleted.

pub const MEMBER_ADD: Self

Member has been added to a guild.

pub const MEMBER_REMOVE: Self

Member has been removed from a guild.

pub const MEMBER_UPDATE: Self

Member in a guild has been updated.

pub const MEMBER_CHUNK: Self

Group of members from a guild.

This may be all of the remaining members or not; the chunk index in the event payload needs to be confirmed.

pub const MESSAGE_CREATE: Self

Message created in a channel.

pub const MESSAGE_DELETE: Self

Message deleted in a channel.

pub const MESSAGE_DELETE_BULK: Self

Multiple messages have been deleted in a channel.

pub const MESSAGE_POLL_VOTE_ADD: Self

Message poll vote has been added.

pub const MESSAGE_POLL_VOTE_REMOVE: Self

Message poll vote has been removed.

pub const MESSAGE_UPDATE: Self

Message in a channel has been updated.

pub const PRESENCE_UPDATE: Self

User’s presence details are updated.

pub const REACTION_ADD: Self

Reaction has been added to a message.

pub const REACTION_REMOVE: Self

Reaction has been removed from a message.

pub const REACTION_REMOVE_ALL: Self

All of the reactions for a message have been removed.

pub const REACTION_REMOVE_EMOJI: Self

All of a given emoji’s reactions for a message have been removed.

pub const READY: Self

Session is initialized.

pub const RESUMED: Self

Session is resumed.

pub const ROLE_CREATE: Self

Role has been created in a guild.

pub const ROLE_DELETE: Self

Role has been deleted in a guild.

pub const ROLE_UPDATE: Self

Role has been updated in a guild.

pub const STAGE_INSTANCE_CREATE: Self

Stage instance was created in a stage channel.

pub const STAGE_INSTANCE_DELETE: Self

Stage instance was deleted in a stage channel.

pub const STAGE_INSTANCE_UPDATE: Self

Stage instance was updated in a stage channel.

pub const THREAD_CREATE: Self

A thread has been created, relevant to the current user, or the current user has been added to a thread.

pub const THREAD_DELETE: Self

A thread, relevant to the current user, has been deleted.

pub const THREAD_LIST_SYNC: Self

The current user has gained access to a thread.

pub const THREAD_MEMBERS_UPDATE: Self

A user has been added to or removed from a thread.

pub const THREAD_MEMBER_UPDATE: Self

The thread member object for the current user has been updated.

pub const THREAD_UPDATE: Self

A thread has been updated.

pub const TYPING_START: Self

User has begun typing in a channel.

pub const UNAVAILABLE_GUILD: Self

Guild is unavailable, potentially due to an outage.

pub const USER_UPDATE: Self

Current user’s profile has been updated.

pub const VOICE_SERVER_UPDATE: Self

Voice server has provided an update with voice session details.

pub const VOICE_STATE_UPDATE: Self

User’s state in a voice channel has been updated.

pub const WEBHOOKS_UPDATE: Self

Webhook in a guild has been updated.

pub const AUTO_MODERATION_CONFIGURATION: Self

All EventTypeFlags in Intents::AUTO_MODERATION_CONFIGURATION.

pub const AUTO_MODERATION_EXECUTION: Self

All EventTypeFlags in Intents::AUTO_MODERATION_EXECUTION.

pub const DIRECT_MESSAGES: Self

All EventTypeFlags in Intents::DIRECT_MESSAGES.

pub const DIRECT_MESSAGE_REACTIONS: Self

All EventTypeFlags in Intents::DIRECT_MESSAGE_REACTIONS.

pub const DIRECT_MESSAGE_TYPING: Self

All EventTypeFlags in Intents::DIRECT_MESSAGE_TYPING.

pub const GUILDS: Self

All EventTypeFlags in Intents::GUILDS.

pub const GUILD_MODERATION: Self

All EventTypeFlags in Intents::GUILD_MODERATION.

pub const GUILD_EMOJIS_AND_STICKERS: Self

All EventTypeFlags in Intents::GUILD_EMOJIS_AND_STICKERS.

pub const GUILD_INTEGRATIONS: Self

All EventTypeFlags in Intents::GUILD_INTEGRATIONS.

pub const GUILD_INVITES: Self

All EventTypeFlags in Intents::GUILD_INVITES.

pub const GUILD_MEMBERS: Self

All EventTypeFlags in Intents::GUILD_MEMBERS.

pub const GUILD_MESSAGES: Self

All EventTypeFlags in Intents::GUILD_MESSAGES.

pub const MESSAGE_POLLS: Self

All EventTypeFlags in Intents::DIRECT_MESSAGE_POLLS and Intents::GUILD_MESSAGE_POLLS.

pub const GUILD_MESSAGE_REACTIONS: Self

All EventTypeFlags in Intents::GUILD_MESSAGE_REACTIONS.

pub const GUILD_MESSAGE_TYPING: Self

All EventTypeFlags in Intents::GUILD_MESSAGE_TYPING.

pub const GUILD_PRESENCES: Self

All EventTypeFlags in Intents::GUILD_PRESENCES.

pub const GUILD_SCHEDULED_EVENTS: Self

All EventTypeFlags in Intents::GUILD_SCHEDULED_EVENTS.

pub const GUILD_VOICE_STATES: Self

All EventTypeFlags in Intents::GUILD_VOICE_STATES.

pub const GUILD_WEBHOOKS: Self

All EventTypeFlags in Intents::GUILD_WEBHOOKS.

impl EventTypeFlags

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

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u128) -> 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: u128) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u128) -> 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 EventTypeFlags

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

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

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 EventTypeFlags

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

Formats the value using the given formatter.

impl BitAnd for EventTypeFlags

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

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

type Output = EventTypeFlags

The resulting type after applying the & operator.

impl BitAndAssign for EventTypeFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for EventTypeFlags

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

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

type Output = EventTypeFlags

The resulting type after applying the | operator.

impl BitOrAssign for EventTypeFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for EventTypeFlags

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

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

type Output = EventTypeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for EventTypeFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for EventTypeFlags

fn clone(&self) -> EventTypeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventTypeFlags

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

Formats the value using the given formatter.

impl Extend<EventTypeFlags> for EventTypeFlags

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 EventTypeFlags

const FLAGS: &'static [Flag<EventTypeFlags>]

The set of defined flags.

type Bits = u128

The underlying bits type.

fn bits(&self) -> u128

Get the underlying bits value.

fn from_bits_retain(bits: u128) -> EventTypeFlags

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 contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are 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 truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

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 clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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 From<EventType> for EventTypeFlags

fn from(event_type: EventType) -> Self

Converts to this type from the input type.

impl FromIterator<EventTypeFlags> for EventTypeFlags

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

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

impl Hash for EventTypeFlags

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 EventTypeFlags

type Item = EventTypeFlags

The type of the elements being iterated over.

type IntoIter = Iter<EventTypeFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for EventTypeFlags

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

Formats the value using the given formatter.

impl Not for EventTypeFlags

fn not(self) -> Self

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

type Output = EventTypeFlags

The resulting type after applying the ! operator.

impl Octal for EventTypeFlags

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

Formats the value using the given formatter.

impl PartialEq for EventTypeFlags

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

type Primitive = u128

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for EventTypeFlags

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

The resulting type after applying the - operator.

impl SubAssign for EventTypeFlags

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 TryFrom<(OpCode, Option<&str>)> for EventTypeFlags

type Error = ()

The type returned in the event of a conversion error.

fn try_from( (op, event_type): (OpCode, Option<&str>), ) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for EventTypeFlags

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

Formats the value using the given formatter.

impl Copy for EventTypeFlags

impl Eq for EventTypeFlags

impl StructuralPartialEq for EventTypeFlags