Struct tungstenite::protocol::frame::Frame
source · pub struct Frame { /* private fields */ }
Expand description
A struct representing a WebSocket frame.
Implementations§
source§impl Frame
impl Frame
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Get the length of the frame. This is the length of the header + the length of the payload.
sourcepub fn header(&self) -> &FrameHeader
pub fn header(&self) -> &FrameHeader
Get a reference to the frame’s header.
sourcepub fn header_mut(&mut self) -> &mut FrameHeader
pub fn header_mut(&mut self) -> &mut FrameHeader
Get a mutable reference to the frame’s header.
sourcepub fn payload_mut(&mut self) -> &mut Vec<u8>
pub fn payload_mut(&mut self) -> &mut Vec<u8>
Get a mutable reference to the frame’s payload.
sourcepub fn into_string(self) -> StdResult<String, FromUtf8Error>
pub fn into_string(self) -> StdResult<String, FromUtf8Error>
Consume the frame into its payload as string.
sourcepub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame
pub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame
Create a new data frame.
sourcepub fn close(msg: Option<CloseFrame<'_>>) -> Frame
pub fn close(msg: Option<CloseFrame<'_>>) -> Frame
Create a new Close control frame.
sourcepub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self
pub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self
Create a frame from given header and data.