Struct WebSocketFrame

Source

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

Expand description

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§

Source §

impl WebSocketFrame

Source

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

AsRef<[u8]> - The raw data to decode into a WebSocket frame.

§Returns

Option<(WebSocketFrame, usize)>
- 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.

Source

pub fn create_frame_list<D>(data: D) -> Vec<ResponseBody> ⓘ
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

AsRef<[u8]> - A reference to a response body (payload) as a byte slice.

§Returns

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

Source

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

AsRef<[u8]> - The input data to be hashed.

§Returns

[u8; 20] - A 20-byte array representing the SHA-1 hash of the input data.

Source

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

AsRef<str> - The client-provided key (typically from the Sec-WebSocket-Key header).

§Returns

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

Source

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.