Enum WebSocketOpcode 

#[repr(u8)]
pub enum WebSocketOpcode {
    Continuation = 0,
    Text = 1,
    Binary = 2,
    Close = 8,
    Ping = 9,
    Pong = 10,
    Reserved(u8),
}

WebSocket frame opcode types

Variants

Continuation = 0

Represents a continuation frame (0x0).

Text = 1

Represents a text frame (0x1).

Binary = 2

Represents a binary frame (0x2).

Close = 8

Represents a connection close frame (0x8).

Ping = 9

Represents a ping frame (0x9).

Pong = 10

Represents a pong frame (0xA).

Reserved(u8)

Represents a reserved opcode for future use, including the specific byte value.

Implementations

impl WebSocketOpcode

pub fn from_u8(opcode: u8) -> Self

Creates a WebSocketOpcode from a raw u8 value.

Arguments

• u8: The raw opcode value.

Returns

• Self - A WebSocketOpcode enum variant corresponding to the raw value.

pub fn to_u8(&self) -> u8

Converts the WebSocketOpcode to its raw u8 value.

Returns

• u8 - The raw u8 value of the opcode.

pub fn is_control(&self) -> bool

Checks if the opcode is a control frame.

Returns

• bool - true if the opcode represents a control frame (Close, Ping, Pong), otherwise false.

pub fn is_data(&self) -> bool

Checks if the opcode is a data frame.

Returns

• bool - true if the opcode represents a data frame (Text, Binary, Continuation), otherwise false.

pub fn is_continuation(&self) -> bool

Checks if the opcode is a continuation frame.

Returns

• bool - true if the opcode is Continuation, otherwise false.

pub fn is_text(&self) -> bool

Checks if the opcode is a text frame.

Returns

• bool - true if the opcode is Text, otherwise false.

pub fn is_binary(&self) -> bool

Checks if the opcode is a binary frame.

Returns

• bool - true if the opcode is Binary, otherwise false.

pub fn is_close(&self) -> bool

Checks if the opcode is a close frame.

Returns

• bool - true if the opcode is Close, otherwise false.

pub fn is_ping(&self) -> bool

Checks if the opcode is a ping frame.

Returns

• bool - true if the opcode is Ping, otherwise false.

pub fn is_pong(&self) -> bool

Checks if the opcode is a pong frame.

Returns

• bool - true if the opcode is Pong, otherwise false.

pub fn is_reserved(&self) -> bool

Checks if the opcode is a reserved frame.

Returns

• bool - true if the opcode is Reserved(_), otherwise false.

Trait Implementations

impl Clone for WebSocketOpcode

fn clone(&self) -> WebSocketOpcode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketOpcode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSocketOpcode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebSocketOpcode

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

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 WebSocketOpcode

impl Eq for WebSocketOpcode

impl StructuralPartialEq for WebSocketOpcode