Enum OpCode

#[non_exhaustive]
#[repr(u8)]
pub enum OpCode {
    Dispatch = 0,
    Heartbeat = 1,
    Identify = 2,
    PresenceUpdate = 3,
    VoiceStateUpdate = 4,
    Resume = 6,
    Reconnect = 7,
    RequestGuildMembers = 8,
    InvalidSession = 9,
    Hello = 10,
    HeartbeatAck = 11,
}

Gateway event’s payload type.

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

DispatchEvent and sequence number.

Will only be received when connected to the gateway with an active session.

Heartbeat = 1

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

Identify = 2

Start a new session.

PresenceUpdate = 3

Request to update the client’s presence.

VoiceStateUpdate = 4

Request to join, leave or move between voice channels.

Resume = 6

Resume a previously disconnected session, skipping over Identify.

Reconnect = 7

Indicates that a reconnect is required.

RequestGuildMembers = 8

Request a list of members for a guild.

InvalidSession = 9

Received when the session is invalidated.

Hello = 10

Received after connecting, contains the heartbeat interval.

HeartbeatAck = 11

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.

pub const fn is_received(self) -> bool

Whether the opcode is received by the client.

This includes the following opcodes:

• Dispatch
• Heartbeat
• HeartbeatAck
• Hello
• InvalidSession
• Reconnect

pub const fn is_sent(self) -> bool

Whether the opcode is sent by the client.

This includes the following opcodes:

• Heartbeat
• Identify
• PresenceUpdate
• Resume
• RequestGuildMembers
• VoiceStateUpdate

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

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