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.

This function parses the raw bytes from a WebSocket stream according to the WebSocket protocol specification to reconstruct a WebSocketFrame. It handles FIN bit, opcode, mask bit, payload length (including extended lengths), mask key, and the payload data itself.

Arguments

• &[u8] - The raw data slice from the WebSocket stream.

Returns

• Some((WebSocketFrame, usize)): If the frame is successfully decoded, returns the decoded frame and the number of bytes consumed from the input slice.
• None: If the frame is incomplete or malformed.

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

Creates a list of response frames from the provided body.

This method segments the response body into WebSocket frames, respecting the maximum frame size and handling UTF-8 character boundaries for text frames. It determines the appropriate opcode (Text or Binary) based on the body’s content.

Arguments

• &ResponseBody - A reference to a response body (payload) as a byte slice.

Returns

• A vector of ResponseBody (byte vectors), where each element represents a framed WebSocket message.

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

Calculates the SHA-1 hash of the input data.

This function implements the SHA-1 cryptographic hash algorithm according to RFC 3174. It processes the input data in 512-bit (64-byte) blocks and produces a 160-bit (20-byte) hash.

Arguments

• &[u8] - 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.

This function is used during the WebSocket handshake to validate the client’s request. It concatenates the client’s key with a specific GUID, calculates the SHA-1 hash of the result, and then encodes the hash in base64.

Arguments

• &str - A string slice containing the client-provided key (typically from the Sec-WebSocket-Key header).

Returns

• A string representing the generated WebSocket accept key (typically for the Sec-WebSocket-Accept header).

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

Encodes the input data as a base64 string.

This function implements the Base64 encoding scheme, converting binary data into an ASCII string format. It processes the input data in chunks of 3 bytes and encodes them into 4 base64 characters. Padding with ‘=’ characters is applied if necessary.

Arguments

• &[u8] - 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.

Returns

true if the opcode is Continuation, otherwise false.

pub fn is_text_opcode(&self) -> bool

Checks if the opcode is a text 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.

Returns

true if the opcode is Binary, otherwise false.

pub fn is_close_opcode(&self) -> bool

Checks if the opcode is a close 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.

Returns

true if the opcode is Ping, otherwise false.

pub fn is_pong_opcode(&self) -> bool

Checks if the opcode is a pong 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.

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.

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

Implements the Default trait for WebSocketFrame.

Provides a default WebSocketFrame with fin: false, opcode: WebSocketOpcode::Text, mask: false, and an empty payload_data.

fn default() -> Self

Returns the default WebSocketFrame.

Returns

A default WebSocketFrame instance.

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 ==.

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