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

Continuation frame (0x0)

Text = 1

Text frame (0x1)

Binary = 2

Binary frame (0x2)

Close = 8

Connection close frame (0x8)

Ping = 9

Ping frame (0x9)

Pong = 10

Pong frame (0xA)

Reserved(u8)

Reserved for future use

Implementations

impl WebSocketOpcode

pub fn from_u8(opcode: u8) -> WebSocketOpcode

Create a WebSocketOpcode from a raw u8 value

Parameters

• opcode: The raw opcode value

Returns

• A WebSocketOpcode enum variant corresponding to the raw value

pub fn to_u8(&self) -> u8

Convert the WebSocketOpcode to its raw u8 value

Returns

• The raw u8 value of the opcode

pub fn is_control(&self) -> bool

Check if the opcode is a control frame

Returns

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

pub fn is_data(&self) -> bool

Check if the opcode is a data frame

Returns

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

pub fn is_continuation(&self) -> bool

Checks if the frame is a continuation frame.

Parameters

• self: The current frame.

Returns

• true if the frame is Continuation, otherwise false.

pub fn is_text(&self) -> bool

Checks if the frame is a text frame.

Parameters

• self: The current frame.

Returns

• true if the frame is Text, otherwise false.

pub fn is_binary(&self) -> bool

Checks if the frame is a binary frame.

Parameters

• self: The current frame.

Returns

• true if the frame is Binary, otherwise false.

pub fn is_close(&self) -> bool

Checks if the frame is a close frame.

Parameters

• self: The current frame.

Returns

• true if the frame is Close, otherwise false.

pub fn is_ping(&self) -> bool

Checks if the frame is a ping frame.

Parameters

• self: The current frame.

Returns

• true if the frame is Ping, otherwise false.

pub fn is_pong(&self) -> bool

Checks if the frame is a pong frame.

Parameters

• self: The current frame.

Returns

• true if the frame is Pong, otherwise false.

pub fn is_reserved(&self) -> bool

Checks if the frame is a reserved frame.

Parameters

• self: The current frame.

Returns

• true if the frame 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<(), Error>

Formats the value using the given formatter.

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 Copy for WebSocketOpcode

impl Eq for WebSocketOpcode

impl StructuralPartialEq for WebSocketOpcode