Enum twilight_model::gateway::event::Event

pub enum Event {
    BanAdd(BanAdd),
    BanRemove(BanRemove),
    ChannelCreate(ChannelCreate),
    ChannelDelete(ChannelDelete),
    ChannelPinsUpdate(ChannelPinsUpdate),
    ChannelUpdate(ChannelUpdate),
    GatewayHeartbeat(u64),
    GatewayHeartbeatAck,
    GatewayHello(u64),
    GatewayInvalidateSession(bool),
    GatewayReconnect,
    GiftCodeUpdate,
    GuildCreate(Box<GuildCreate>),
    GuildDelete(Box<GuildDelete>),
    GuildEmojisUpdate(GuildEmojisUpdate),
    GuildIntegrationsUpdate(GuildIntegrationsUpdate),
    GuildUpdate(Box<GuildUpdate>),
    InviteCreate(Box<InviteCreate>),
    InviteDelete(InviteDelete),
    MemberAdd(Box<MemberAdd>),
    MemberRemove(MemberRemove),
    MemberUpdate(Box<MemberUpdate>),
    MemberChunk(MemberChunk),
    MessageCreate(Box<MessageCreate>),
    MessageDelete(MessageDelete),
    MessageDeleteBulk(MessageDeleteBulk),
    MessageUpdate(Box<MessageUpdate>),
    PresenceUpdate(Box<PresenceUpdate>),
    PresencesReplace,
    ReactionAdd(Box<ReactionAdd>),
    ReactionRemove(Box<ReactionRemove>),
    ReactionRemoveAll(ReactionRemoveAll),
    ReactionRemoveEmoji(ReactionRemoveEmoji),
    Ready(Box<Ready>),
    Resumed,
    RoleCreate(RoleCreate),
    RoleDelete(RoleDelete),
    RoleUpdate(RoleUpdate),
    ShardConnected(Connected),
    ShardConnecting(Connecting),
    ShardDisconnected(Disconnected),
    ShardIdentifying(Identifying),
    ShardReconnecting(Reconnecting),
    ShardPayload(Payload),
    ShardResuming(Resuming),
    TypingStart(Box<TypingStart>),
    UnavailableGuild(UnavailableGuild),
    UserUpdate(UserUpdate),
    VoiceServerUpdate(VoiceServerUpdate),
    VoiceStateUpdate(Box<VoiceStateUpdate>),
    WebhooksUpdate(WebhooksUpdate),
}

Any type of event that a shard emits.

This brings together all of the types of DispatchEvents, GatewayEvents, and ShardEvents.

Variants

BanAdd(BanAdd)

A user was banned from a guild.

BanRemove(BanRemove)

A user's ban from a guild was removed.

ChannelCreate(ChannelCreate)

A channel was created.

ChannelDelete(ChannelDelete)

A channel was deleted.

ChannelPinsUpdate(ChannelPinsUpdate)

A channel's pins were updated.

ChannelUpdate(ChannelUpdate)

A channel was updated.

GatewayHeartbeat(u64)

A heartbeat was sent to or received from the gateway.

GatewayHeartbeatAck

A heartbeat acknowledgement was received from the gateway.

GatewayHello(u64)

A "hello" packet was received from the gateway.

GatewayInvalidateSession(bool)

A shard's session was invalidated.

true if resumeable. If not, then the shard must do a full reconnect.

GatewayReconnect

The gateway is indicating to perform a reconnect.

GiftCodeUpdate

Undocumented event, should be ignored

GuildCreate(Box<GuildCreate>)

A guild was created.

GuildDelete(Box<GuildDelete>)

A guild was deleted or the current user was removed from a guild.

GuildEmojisUpdate(GuildEmojisUpdate)

A guild's emojis were updated.

GuildIntegrationsUpdate(GuildIntegrationsUpdate)

A guild's integrations were updated.

GuildUpdate(Box<GuildUpdate>)

A guild was updated.

InviteCreate(Box<InviteCreate>)

A invite was made.

InviteDelete(InviteDelete)

A invite was deleted.

MemberAdd(Box<MemberAdd>)

A user was added to a guild.

MemberRemove(MemberRemove)

A user was removed from a guild.

MemberUpdate(Box<MemberUpdate>)

A user's member object in a guild was updated.

MemberChunk(MemberChunk)

A chunk of members were received from the gateway.

MessageCreate(Box<MessageCreate>)

A message was created in a channel.

MessageDelete(MessageDelete)

A message was deleted in a channel.

MessageDeleteBulk(MessageDeleteBulk)

Multiple messages were deleted in a channel.

MessageUpdate(Box<MessageUpdate>)

A message was updated in a channel.

PresenceUpdate(Box<PresenceUpdate>)

A user's active presence (such as game or online status) was updated.

PresencesReplace

Multiple presences outside of a guild were updated.

For bots this is always empty and useless.

ReactionAdd(Box<ReactionAdd>)

A reaction was added to a message.

ReactionRemove(Box<ReactionRemove>)

A reaction was removed from a message.

ReactionRemoveAll(ReactionRemoveAll)

All reactions were removed from a message.

ReactionRemoveEmoji(ReactionRemoveEmoji)

All instances of a given emoji from the reactions of a message were removed.

Ready(Box<Ready>)

A shard is now "ready" and fully connected.

Resumed

A shard has successfully resumed.

RoleCreate(RoleCreate)

A role was created in a guild.

RoleDelete(RoleDelete)

A role was deleted in a guild.

RoleUpdate(RoleUpdate)

A role was updated in a guild.

ShardConnected(Connected)

A shard is now in a connected stage after being fully connected to the gateway.

ShardConnecting(Connecting)

A shard is now in a connecting stage after starting to connect to the gateway.

ShardDisconnected(Disconnected)

A shard is now in a disconnected stage after the connection was closed.

ShardIdentifying(Identifying)

A shard is now in a identifying stage after starting a new session.

ShardReconnecting(Reconnecting)

A shard is now in a reconnecting stage after a disconnect or session was ended.

ShardPayload(Payload)

A payload of bytes came in through the shard's connection.

ShardResuming(Resuming)

A shard is now in a Resuming stage after a disconnect.

TypingStart(Box<TypingStart>)

A user started typing in a channel.

UnavailableGuild(UnavailableGuild)

A guild is now unavailable.

UserUpdate(UserUpdate)

The current user was updated.

VoiceServerUpdate(VoiceServerUpdate)

A voice server update was sent.

VoiceStateUpdate(Box<VoiceStateUpdate>)

A voice state in a voice channel was updated.

WebhooksUpdate(WebhooksUpdate)

A webhook was updated.

Implementations

impl Event

pub fn kind(&self) -> EventType

Trait Implementations

impl Clone for Event

pub fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl From<Box<DispatchEvent, Global>> for Event

pub fn from(event: Box<DispatchEvent>) -> Self

Performs the conversion.

impl From<GatewayEvent> for Event

pub fn from(event: GatewayEvent) -> Self

Performs the conversion.

impl From<ShardEvent> for Event

pub fn from(event: ShardEvent) -> Self

Performs the conversion.

impl PartialEq<Event> for Event

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

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

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

This method tests for !=.

impl StructuralEq for Event

impl StructuralPartialEq for Event

impl TryFrom<Event> for GatewayEvent

type Error = EventConversionError

The type returned in the event of a conversion error.

pub fn try_from(event: Event) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Event> for ShardEvent

type Error = EventConversionError

The type returned in the event of a conversion error.

pub fn try_from(event: Event) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Event> for DispatchEvent

type Error = EventConversionError

The type returned in the event of a conversion error.

pub fn try_from(event: Event) -> Result<Self, Self::Error>

Performs the conversion.