Struct esp_idf_sys::httpd_ws_frame

#[repr(C)]
pub struct httpd_ws_frame {
    pub final_: bool,
    pub fragmented: bool,
    pub type_: httpd_ws_type_t,
    pub payload: *mut u8,
    pub len: usize,
}

@brief WebSocket frame format

Fields

final_: bool

< Final frame: For received frames this field indicates whether the FIN flag was set. For frames to be transmitted, this field is only used if the fragmented option is set as well. If fragmented is false, the FIN flag is set by default, marking the ws_frame as a complete/unfragmented message (esp_http_server doesn’t automatically fragment messages)

fragmented: bool

< Indication that the frame allocated for transmission is a message fragment, so the FIN flag is set manually according to the final option. This flag is never set for received messages

type_: httpd_ws_type_t

< WebSocket frame type

payload: *mut u8

< Pre-allocated data buffer

len: usize

< Length of the WebSocket data

Trait Implementations

impl Clone for httpd_ws_frame

fn clone(&self) -> httpd_ws_frame

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for httpd_ws_frame

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

Formats the value using the given formatter.

impl Default for httpd_ws_frame

fn default() -> Self

Returns the “default value” for a type.

impl Copy for httpd_ws_frame