Struct ws_tool::frame::OwnedFrame

pub struct OwnedFrame { /* private fields */ }

owned frame

Implementations

impl OwnedFrame

pub fn new(code: OpCode, mask: impl Into<Option<[u8; 4]>>, data: &[u8]) -> Self

construct new owned frame

pub fn with_raw(header: Header, payload: BytesMut) -> Self

use constructed header and payload

NOTE: this will not check header and payload

pub fn text_frame(mask: impl Into<Option<[u8; 4]>>, data: &str) -> Self

helper function to construct a text frame

pub fn binary_frame(mask: impl Into<Option<[u8; 4]>>, data: &[u8]) -> Self

helper function to construct a binary frame

pub fn ping_frame(mask: impl Into<Option<[u8; 4]>>, data: &[u8]) -> Self

helper function to construct a ping frame

pub fn pong_frame(mask: impl Into<Option<[u8; 4]>>, data: &[u8]) -> Self

helper function to construct a pong frame

pub fn close_frame( mask: impl Into<Option<[u8; 4]>>, code: impl Into<Option<u16>>, data: &[u8] ) -> Self

helper function to construct a close frame

pub fn unmask(&mut self) -> Option<[u8; 4]>

unmask frame if masked

pub fn mask(&mut self, mask: [u8; 4])

mask frame with provide mask key

this will override old mask

pub fn extend_from_slice(&mut self, data: &[u8])

extend frame payload

NOTE this function will unmask first, and then extend payload, mask with old mask key finally

pub fn header(&self) -> &Header

get frame header

pub fn header_mut(&mut self) -> &mut Header

get mutable frame header

pub fn payload(&self) -> &BytesMut

get payload

pub fn parts(self) -> (Header, BytesMut)

consume frame return header and payload

Trait Implementations

impl Clone for OwnedFrame

fn clone(&self) -> OwnedFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedFrame

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

Formats the value using the given formatter.