Struct Frame

pub struct Frame {
    header: FrameHeader,
    payload: Vec<u8>,
}

A struct representing a WebSocket frame.

Fields

header: FrameHeader

payload: Vec<u8>

Implementations

impl Frame

pub fn len(&self) -> usize

Get the length of the frame. This is the length of the header + the length of the payload.

pub fn is_empty(&self) -> bool

Check if the frame is empty.

pub fn header(&self) -> &FrameHeader

Get a reference to the frame’s header.

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

Get a mutable reference to the frame’s header.

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

Get a reference to the frame’s payload.

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

Get a mutable reference to the frame’s payload.

pub(crate) fn is_masked(&self) -> bool

Test whether the frame is masked.

pub(crate) fn set_random_mask(&mut self)

Generate a random mask for the frame.

This just generates a mask, payload is not changed. The actual masking is performed either on format() or on apply_mask() call.

pub(crate) fn apply_mask(&mut self)

This method unmasks the payload and should only be called on frames that are actually masked. In other words, those frames that have just been received from a client endpoint.

pub fn into_data(self) -> Vec<u8>

Consume the frame into its payload as binary.

pub fn into_string(self) -> StdResult<String, FromUtf8Error>

Consume the frame into its payload as string.

pub fn to_text(&self) -> Result<&str, Utf8Error>

Get frame payload as &str.

pub(crate) fn into_close(self) -> Result<Option<CloseFrame<'static>>>

Consume the frame into a closing frame.

pub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame

Create a new data frame.

pub fn pong(data: Vec<u8>) -> Frame

Create a new Pong control frame.

pub fn ping(data: Vec<u8>) -> Frame

Create a new Ping control frame.

pub fn close(msg: Option<CloseFrame<'_>>) -> Frame

Create a new Close control frame.

pub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self

Create a frame from given header and data.

pub fn format(self, output: &mut impl Write) -> Result<()>

Write a frame out to a buffer

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Display for Frame

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

Formats the value using the given formatter.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Frame

impl StructuralPartialEq for Frame