Enum twilight_model::gateway::OpCode

#[non_exhaustive]
#[repr(u8)]
pub enum OpCode {
    Dispatch,
    Heartbeat,
    Identify,
    PresenceUpdate,
    VoiceStateUpdate,
    Resume,
    Reconnect,
    RequestGuildMembers,
    InvalidSession,
    Hello,
    HeartbeatAck,
}

Gateway event opcodes.

The documentation is written from a client’s perspective.

PresenceUpdate, RequestGuildMembers, and VoiceStateUpdate are not requiried for establishing or maintaining a gateway connection.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Dispatch

DispatchEvent and sequence number.

Will only be received after establishing or resuming a session.

Heartbeat

Periodically sent to maintain the connection and may be received to immediately request one.

Identify

Start a new session.

PresenceUpdate

Request to update the client’s presence.

VoiceStateUpdate

Request to join, leave or move between voice channels.

Resume

Resume a previously disconnected session, skipping over Identify.

Reconnect

Indicates that a reconnect is required.

RequestGuildMembers

Request a list of members for a guild.

InvalidSession

Received when the session is invalidated.

Hello

Received after connecting, contains the heartbeat interval.

HeartbeatAck

Received in response to sending a Heartbeat.

Implementations

impl OpCode

pub const fn from(code: u8) -> Option<Self>

Try to match an integer value to an opcode, returning None if no match is found.

Trait Implementations

impl Clone for OpCode

fn clone(&self) -> OpCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpCode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for OpCode

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 PartialEq<OpCode> for OpCode

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for OpCode

impl Eq for OpCode

impl StructuralEq for OpCode

impl StructuralPartialEq for OpCode