Struct esp_idf_sys::httpd_ws_frame

source ·
#[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, }
Expand description

@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§

source§

impl Clone for httpd_ws_frame

source§

fn clone(&self) -> httpd_ws_frame

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl Debug for httpd_ws_frame

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for httpd_ws_frame

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Copy for httpd_ws_frame

Auto Trait Implementations§

§

impl Freeze for httpd_ws_frame

§

impl RefUnwindSafe for httpd_ws_frame

§

impl !Send for httpd_ws_frame

§

impl !Sync for httpd_ws_frame

§

impl Unpin for httpd_ws_frame

§

impl UnwindSafe for httpd_ws_frame

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CloneToUninit for T
where T: Copy,

§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.