Enum Opcode

pub enum Opcode {
    Continuation = 0,
    Text = 1,
    Binary = 2,
    ConnectionClose = 8,
    Ping = 9,
    Pong = 10,
    // some variants omitted
}

WebSocket frame type.

Also includes reserved opcode types as #[doc(hidden)] items.

Variants

Continuation = 0

A continuation frame. Follows Opcode::Text or Opcode::Binary frames, extending content of it. Final Continuation frames has FrameInfo::fin set to true.

There may be control frames (e.g. Opcode::Ping) between initial data frame and continuation frames.

Text = 1

First frame of a text WebSocket message.

Binary = 2

First frame of a binary WebSocket message.

ConnectionClose = 8

Last frame, indicating that WebSocket connection is now closed. You should close the socket upon receipt of this message.

Ping = 9

WebSocket ping message. You should copy the payload to outgoing Opcode::Pong frame.

Pong = 10

A reply to Opcode::Pong message.

Implementations

impl Opcode

pub fn is_data(&self) -> bool

Check if this opcode is of a data frame.

pub fn is_control(&self) -> bool

Check if this opcode is of a control frame.

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 Default for Opcode

fn default() -> Opcode

Returns the “default value” for a type.

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 Ord for Opcode

fn cmp(&self, other: &Opcode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for Opcode

fn partial_cmp(&self, other: &Opcode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Opcode

impl Eq for Opcode

impl StructuralPartialEq for Opcode