Struct Frame

pub struct Frame {
    pub fin: bool,
    pub rsv1: bool,
    pub rsv2: bool,
    pub rsv3: bool,
    pub opcode: OpCode,
    pub mask: Option<[u8; 4]>,
    pub payload: Vec<u8>,
}

Represents a WebSocket frame.

Fields

fin: bool

Indicates if this is the final fragment in a message.

rsv1: bool

First reserved bit.

rsv2: bool

Second reserved bit.

rsv3: bool

Third reserved bit.

opcode: OpCode

The opcode for this frame.

mask: Option<[u8; 4]>

The masking key, if any.

payload: Vec<u8>

The payload data.

Implementations

impl Frame

pub fn new(opcode: OpCode, payload: Vec<u8>) -> Self

Creates a new Frame with the given opcode and payload.

pub fn close(status_code: Option<u16>) -> Self

Creates a close frame with an optional status code.

pub fn is_close(&self) -> bool

Checks if this frame is a close frame.

pub fn is_masked(&self) -> bool

Checks if this frame is masked.

pub async fn read_from<R: AsyncRead + Unpin>(reader: &mut R) -> Result<Self>

Reads a frame from the given AsyncRead stream.

Errors

Returns an error if reading from the stream fails or if the frame is invalid.

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

Converts the frame to a byte vector.

Trait Implementations

impl Debug for Frame

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

Formats the value using the given formatter.