Struct Frame

pub struct Frame { /* private fields */ }

A struct representing a WebSocket frame.

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) -> &[u8]

Get a reference to the frame’s payload.

pub fn into_text(self) -> Result<Utf8Bytes, Utf8Error>

Consume the frame into its payload as string.

pub fn into_payload(self) -> Bytes

Consume the frame into its payload.

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

Get frame payload as &str.

pub fn message(data: impl Into<Bytes>, opcode: OpCode, is_final: bool) -> Frame

Create a new data frame.

pub fn pong(data: impl Into<Bytes>) -> Frame

Create a new Pong control frame.

pub fn ping(data: impl Into<Bytes>) -> 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: Bytes) -> Frame

Create a frame from given header and data.

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

Write a frame out to a buffer

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Display for Frame

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

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