Struct Frame 

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

Fields

fin: bool

opcode: OpCode

mask: Option<[u8; 4]>

Present only on frames a client sends. A server that masks its frames is as wrong as a client that does not.

payload: Vec<u8>

Implementations

impl Frame

pub fn server(opcode: OpCode, payload: Vec<u8>) -> Frame

A frame as a server sends it: final, and never masked.

pub fn client(opcode: OpCode, payload: Vec<u8>, mask: [u8; 4]) -> Frame

A frame as a client sends it. The mask is supplied rather than generated so encoding stays a pure function that a test can pin to exact bytes.

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

pub fn decode( bytes: &[u8], role: Role, max_payload: usize, ) -> WsResult<Option<(Frame, usize)>>

Decode one frame from the front of bytes.

Returns Ok(None) when the buffer does not hold a whole frame yet — the caller reads more and asks again — and the number of bytes consumed alongside the frame so the caller can drain exactly that much.

max_payload is checked against the declared length, before anything is allocated, so a peer announcing a 4 GiB frame costs nothing.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

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.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame