Struct WebSocketFrame

pub struct WebSocketFrame { /* private fields */ }

Represents a decoded WebSocket frame

Implementations

impl WebSocketFrame

pub fn decode_websocket_frame_with_length( data: &[u8], ) -> Option<(WebSocketFrame, usize)>

decode_websocket_frame_with_length

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: &Vec<u8>) -> Vec<Vec<u8>>

create_response_frame_list

• 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]

sha1

• 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

generate_accept_key

• 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

base64_encode

• data: A byte slice containing the data to encode in base64.
• Returns: A string with the base64 encoded representation of the input data.

impl WebSocketFrame

pub fn get_fin(&self) -> &bool

pub fn get_mut_fin(&mut self) -> &mut bool

pub fn get_opcode(&self) -> &u8

pub fn get_mut_opcode(&mut self) -> &mut u8

pub fn get_mask(&self) -> &bool

pub fn get_mut_mask(&mut self) -> &mut bool

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

pub fn get_mut_payload_data(&mut self) -> &mut Vec<u8>

Trait Implementations

impl Clone for WebSocketFrame

fn clone(&self) -> WebSocketFrame

Returns a copy 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

fn default() -> WebSocketFrame

Returns the “default value” for a type.

impl Display for WebSocketFrame

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

Formats the value using the given formatter.