Struct Frame 

pub struct Frame {
    pub fin: bool,
    pub rsv: [bool; 3],
    pub opcode: Opcode,
    pub masked: bool,
    pub mask: Option<[u8; 4]>,
    pub payload: Bytes,
}

Represents a WebSocket frame according to RFC 6455

Fields

fin: bool

Indicates if this is the final frame in a message

rsv: [bool; 3]

Reserved bits (RSV1, RSV2, RSV3)

opcode: Opcode

Frame opcode

masked: bool

Indicates if the payload is masked

mask: Option<[u8; 4]>

Masking key (if present)

payload: Bytes

Payload data

Implementations

impl Frame

pub fn new(opcode: Opcode, payload: impl Into<Bytes>) -> Self

Create a new frame with the given opcode and payload

pub fn continuation(payload: impl Into<Bytes>) -> Self

Create a continuation frame

pub fn text(payload: impl Into<Bytes>) -> Self

Create a text frame

pub fn binary(payload: impl Into<Bytes>) -> Self

Create a binary frame

pub fn close(code: Option<u16>, reason: Option<&str>) -> Self

Create a close frame with optional code and reason

pub fn ping(payload: impl Into<Bytes>) -> Self

Create a ping frame

pub fn pong(payload: impl Into<Bytes>) -> Self

Create a pong frame

pub fn fin(self, fin: bool) -> Self

Set the FIN bit

pub fn rsv(self, rsv1: bool, rsv2: bool, rsv3: bool) -> Self

Set reserved bits

pub fn mask(self, enabled: bool) -> Self

Apply masking to the frame (for client frames)

pub fn compress(self, enabled: bool) -> Self

Available on crate feature compression only.

Apply compression to the frame (for data frames)

pub fn to_bytes(&self) -> Bytes

Serialize the frame to bytes

pub fn write_to(&self, buf: &mut BytesMut)

Write the frame to a buffer

pub fn parse(buf: &mut BytesMut, compression_enabled: bool) -> Result<Self>

Parse a frame from bytes

pub fn kind(&self) -> FrameKind

Get the frame kind

pub fn payload_len(&self) -> usize

Get the payload length

pub fn is_control(&self) -> bool

Check if this is a control frame

pub fn is_data(&self) -> bool

Check if this is a data frame

pub fn is_final(&self) -> bool

Check if this is the final frame

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

Formats the value using the given formatter.