Struct twilight_gateway::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 [Shard]s. 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 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 GIFT_CODE_UPDATE: Self = _

Gift code sent in a channel has been updated.

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_UPDATE: Self = _

Message in a channel has been updated.

pub const PRESENCE_UPDATE: Self = _

User’s presence details are updated.

pub const PRESENCES_REPLACE: Self = _

Group of presences are replaced.

This is a placeholder as it can happen for bots but has no real meaning.

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_BANS: Self = _

👎Deprecated since 0.14.3: use the GUILD_MODERATION intent instead

All EventTypeFlags in Intents::GUILD_BANS.

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

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u128

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u128) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u128) -> Self

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

pub const unsafe fn from_bits_unchecked(bits: u128) -> 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.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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

impl Binary for EventTypeFlags

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

Formats the value using the given formatter.

impl BitAnd<EventTypeFlags> for EventTypeFlags

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

Returns the intersection between the two sets of flags.

type Output = EventTypeFlags

The resulting type after applying the & operator.

impl BitAndAssign<EventTypeFlags> for EventTypeFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<EventTypeFlags> for EventTypeFlags

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

Returns the union of the two sets of flags.

type Output = EventTypeFlags

The resulting type after applying the | operator.

impl BitOrAssign<EventTypeFlags> for EventTypeFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<EventTypeFlags> for EventTypeFlags

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

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

type Output = EventTypeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<EventTypeFlags> for EventTypeFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

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)

Extends a collection with the contents of an iterator.

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

Creates a value from an iterator.

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

Returns the complement of this set of flags.

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

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<EventTypeFlags> for EventTypeFlags

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<EventTypeFlags> for EventTypeFlags

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

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

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

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

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

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

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

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

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

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

impl Sub<EventTypeFlags> for EventTypeFlags

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

Returns the set difference of the two sets of flags.

type Output = EventTypeFlags

The resulting type after applying the - operator.

impl SubAssign<EventTypeFlags> for EventTypeFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

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

impl StructuralPartialEq for EventTypeFlags