Struct WebSocketFrame 

pub struct WebSocketFrame {
    pub fin: bool,
    pub opcode: WebSocketOpcode,
    pub mask: bool,
    pub payload_data: Vec<u8>,
}

Represents a decoded WebSocket frame.

Fields

fin: bool

FIN flag indicating if this is the final frame.

opcode: WebSocketOpcode

Opcode indicating the frame type (text, binary, etc.).

mask: bool

Mask flag indicating if the payload is masked.

payload_data: Vec<u8>

The payload data of the frame.

Implementations

impl WebSocketFrame

Inherent implementation of WebSocketFrame.

pub fn decode_ws_frame<D>(data: D) -> Option<(WebSocketFrame, usize)>

where D: AsRef<[u8]>,

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

• D - The raw data to decode into a WebSocket frame, which requires the AsRef<[u8]> bound.

Returns

• Option<(WebSocketFrame, usize)> - Some((frame, consumed)) when the frame is successfully decoded, otherwise None when the frame is incomplete or malformed.

pub fn create_frame_list<D>(data: D) -> Vec<Vec<u8>>

where D: AsRef<[u8]>,

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

• D - A reference to a response body (payload) as a byte slice, which requires the AsRef<[u8]> bound.

Returns

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

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

where D: AsRef<[u8]>,

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

• D - The input data to be hashed, which requires the AsRef<[u8]> bound.

Returns

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

pub fn try_generate_accept_key<K>(key: K) -> Option<String>

where K: AsRef<str>,

Generates a WebSocket accept key from the client-provided key, returning an Option<String>.

Arguments

• K - The client-provided key (typically from the Sec-WebSocket-Key header), which requires the AsRef<str> bound.

Returns

• Option<String> - An optional string representing the generated WebSocket accept key (typically for the Sec-WebSocket-Accept header).

pub fn generate_accept_key<K>(key: K) -> String

where K: AsRef<str>,

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

• K - The client-provided key (typically from the Sec-WebSocket-Key header), which requires the AsRef<str> bound.

Returns

• String - The generated WebSocket accept key (typically for the Sec-WebSocket-Accept header).

Panics

This function will panic if the input key cannot be converted to a UTF-8 string.

pub fn try_base64_encode<D>(data: D) -> Option<String>

where D: AsRef<[u8]>,

Encodes the input data as a base64 string, returning an Option<String>.

Arguments

• D - The data to encode in base64, which requires the AsRef<[u8]> bound.

Returns

• Option<String> - An optional string with the base64 encoded representation of the input data.

pub fn base64_encode<D>(data: D) -> String

where D: AsRef<[u8]>,

Encodes the input data as a base64 string.

Arguments

• D - The data to encode in base64, which requires the AsRef<[u8]> bound.

Returns

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

Panics

This function will panic if the input data cannot be converted to a UTF-8 string.

pub fn is_continuation_opcode(&self) -> bool

Checks if the opcode is a continuation frame.

Returns

• bool - true if the opcode is Continuation, otherwise false.

pub fn is_text_opcode(&self) -> bool

Checks if the opcode is a text frame.

Returns

• bool - true if the opcode is Text, otherwise false.

pub fn is_binary_opcode(&self) -> bool

Checks if the opcode is a binary frame.

Returns

• bool - true if the opcode is Binary, otherwise false.

pub fn is_close_opcode(&self) -> bool

Checks if the opcode is a close frame.

Returns

• bool - true if the opcode is Close, otherwise false.

pub fn is_ping_opcode(&self) -> bool

Checks if the opcode is a ping frame.

Returns

• bool - true if the opcode is Ping, otherwise false.

pub fn is_pong_opcode(&self) -> bool

Checks if the opcode is a pong frame.

Returns

• bool - true if the opcode is Pong, otherwise false.

pub fn is_reserved_opcode(&self) -> bool

Checks if the opcode is a reserved frame.

Returns

• bool - 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<(), Error>

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() -> WebSocketFrame

Returns the default WebSocketFrame.

Returns

• Self - A default WebSocketFrame instance.

impl Display for WebSocketFrame

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

Formats the value using the standard debug format.

Arguments

• &mut std::fmt::Formatter<'_> - The formatter to write the representation into.

Returns

• std::fmt::Result - Success or failure of the formatting operation.

impl Eq for WebSocketFrame

impl PartialEq for WebSocketFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WebSocketFrame