Struct WebSocketFrame

pub struct WebSocketFrame { /* private fields */ }

Represents a decoded WebSocket frame

Implementations

impl WebSocketFrame

pub fn decode_ws_frame(data: &[u8]) -> WebsocketFrameWithLengthOption

Decodes a WebSocket frame from the provided data slice.

Parameters

• data: The raw data slice from the WebSocket stream.

Returns

• An Option containing a tuple (WebSocketFrame, usize), where the WebSocketFrame is the decoded frame and usize is the number of bytes consumed. Returns None if the frame is incomplete.

pub fn create_response_frame_list(body: &ResponseBody) -> Vec<ResponseBody>

Creates a list of response frames from the provided body.

Parameters

• body: A reference to a response body (payload) as a byte slice.

Returns

• A vector of response bodies (frames) representing the framed data.

pub fn sha1(data: &[u8]) -> [u8; 20]

Calculates the SHA-1 hash of the input data.

Parameters

• data: A byte slice containing the input data to be hashed.

Returns

• A 20-byte array representing the SHA-1 hash of the input data.

pub fn generate_accept_key(key: &str) -> String

Generates a WebSocket accept key from the client-provided key.

Parameters

• key: A string slice containing the client-provided key.

Returns

• A string representing the generated WebSocket accept key.

pub fn base64_encode(data: &[u8]) -> String

Encodes the input data as a base64 string.

Parameters

• data: A byte slice containing the data to encode in base64.

Returns

• A string with the base64 encoded representation of the input data.

pub fn is_continuation_opcode(&self) -> bool

Checks if the opcode is a continuation frame.

Parameters

• self: The current frame.

Returns

• true if the opcode is Continuation, otherwise false.

pub fn is_text_opcode(&self) -> bool

Checks if the opcode is a text frame.

Parameters

• self: The current frame.

Returns

• true if the opcode is Text, otherwise false.

pub fn is_binary_opcode(&self) -> bool

Checks if the opcode is a binary frame.

Parameters

• self: The current frame.

Returns

• true if the opcode is Binary, otherwise false.

pub fn is_close_opcode(&self) -> bool

Checks if the opcode is a close frame.

Parameters

• self: The current frame.

Returns

• true if the opcode is Close, otherwise false.

pub fn is_ping_opcode(&self) -> bool

Checks if the opcode is a ping frame.

Parameters

• self: The current frame.

Returns

• true if the opcode is Ping, otherwise false.

pub fn is_pong_opcode(&self) -> bool

Checks if the opcode is a pong frame.

Parameters

• self: The current frame.

Returns

• true if the opcode is Pong, otherwise false.

pub fn is_reserved_opcode(&self) -> bool

Checks if the opcode is a reserved frame.

Parameters

• self: The current frame.

Returns

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

impl WebSocketFrame

pub fn get_fin(&self) -> &bool

pub fn get_opcode(&self) -> &WebSocketOpcode

pub fn get_mask(&self) -> &bool

pub fn get_payload_data(&self) -> &Vec<u8>

Trait Implementations

impl Clone for WebSocketFrame

fn clone(&self) -> WebSocketFrame

Returns a duplicate of the value.

const 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 Default for WebSocketFrame

fn default() -> Self

Returns the “default value” for a type.

impl Display for WebSocketFrame

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

Formats the value using the given formatter.

impl PartialEq for WebSocketFrame

fn eq(&self, other: &WebSocketFrame) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 Eq for WebSocketFrame

impl StructuralPartialEq for WebSocketFrame