Struct FrameInfo

pub struct FrameInfo {
    pub opcode: Opcode,
    pub payload_length: PayloadLength,
    pub mask: Option<[u8; 4]>,
    pub fin: bool,
    pub reserved: u8,
}

Information about WebSocket frame header.

Fields

opcode: Opcode

Type of this WebSocket frame

payload_length: PayloadLength

Length of this frame’s payload. Not to be confused with WebSocket message length, which is unknown, unless FrameInfo::fin is set.

mask: Option<[u8; 4]>

Whether this frame uses (or should use, for encoder) masking (and the mask used)

fin: bool

Whether this frame is a final frame and no Opcode::Continuation should follow to extend the content of it.

reserved: u8

Should be 0 unless some extensions are used.

Implementations

impl FrameInfo

pub const fn is_reasonable(&self) -> bool

Indicates that this frame looks like a normal, well-formed frame (not considering WebSocket extensions).

Does not check for valitity of a frame within a sequence of frames, e.g. for orphaned Opcode::Continuation frames or for unfinished prior messages.

Trait Implementations

impl Clone for FrameInfo

fn clone(&self) -> FrameInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrameInfo

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

Formats the value using the given formatter.

impl Default for FrameInfo

fn default() -> FrameInfo

Returns the “default value” for a type.

impl PartialEq for FrameInfo

fn eq(&self, other: &FrameInfo) -> 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 Copy for FrameInfo

impl Eq for FrameInfo

impl StructuralPartialEq for FrameInfo