Struct WebSocketFrame 

pub struct WebSocketFrame {
    pub fin: bool,
    pub opcode: Opcode,
    pub mask: Option<[u8; 4]>,
    pub payload: Vec<u8>,
}

A parsed WebSocket frame

Fields

fin: bool

FIN bit - true if this is the final frame of a message

opcode: Opcode

Frame opcode

mask: Option<[u8; 4]>

Masking key (only for client-to-server frames)

payload: Vec<u8>

Frame payload data (unmasked)

Implementations

impl WebSocketFrame

pub fn new(opcode: Opcode, payload: Vec<u8>) -> Self

Create a new frame

pub fn close(code: u16, reason: &str) -> Self

Create a close frame

pub fn ping(data: Vec<u8>) -> Self

Create a ping frame

pub fn pong(data: Vec<u8>) -> Self

Create a pong frame

pub fn with_mask(self, mask: [u8; 4]) -> Self

Set the masking key (for client frames)

pub fn with_fin(self, fin: bool) -> Self

Set the FIN bit

pub fn close_code_and_reason(&self) -> Option<(u16, String)>

Parse close code and reason from payload

Trait Implementations

impl Clone for WebSocketFrame

fn clone(&self) -> WebSocketFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketFrame

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

Formats the value using the given formatter.

impl Encoder<WebSocketFrame> for WebSocketCodec

type Error = Error

The type of encoding errors.

fn encode( &mut self, frame: WebSocketFrame, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.