Struct Frame 

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

WebSocket-Frame — RFC 6455 §5.2.

Fields

fin: bool

Spec §5.2 — FIN bit. Final fragment indicator.

rsv1: bool

Spec §5.2 — RSV1 bit. MUST be 0 unless extension negotiated.

rsv2: bool

Spec §5.2 — RSV2 bit.

rsv3: bool

Spec §5.2 — RSV3 bit.

opcode: Opcode

Spec §5.2 — Opcode.

masking_key: Option<[u8; 4]>

Spec §5.2 — Masking-Key (Some wenn MASK=1; immer Some von client→server).

payload: Vec<u8>

Spec §5.2 — Payload (already unmasked beim Decode; wird beim Encode automatisch maskiert wenn masking_key gesetzt).

Implementations

impl Frame

pub fn text(s: impl Into<String>) -> Self

Konstruiert einen unmaskierten Text-Frame mit FIN=1.

pub const fn binary(payload: Vec<u8>) -> Self

Konstruiert einen unmaskierten Binary-Frame mit FIN=1.

pub const fn ping(payload: Vec<u8>) -> Self

Konstruiert einen Ping-Frame (FIN=1, max. 125 Bytes Payload — Spec §5.5).

pub const fn pong(payload: Vec<u8>) -> Self

Konstruiert einen Pong-Frame (Spec §5.5.3 — als Reply-zu-Ping MUST denselben Payload haben).

pub fn close(status: u16, reason: &str) -> Self

Konstruiert einen Close-Frame mit Status-Code + optionaler Reason. Spec §5.5.1 + §7.4.

pub const fn with_mask(self, key: [u8; 4]) -> Self

Aktiviert Client→Server-Masking. Spec §5.3 — “All frames sent from client to server have this bit set to 1”.

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.

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