Struct FrameHeader

pub struct FrameHeader {
    pub is_final: bool,
    pub rsv1: bool,
    pub rsv2: bool,
    pub rsv3: bool,
    pub opcode: OpCode,
    pub mask: Option<[u8; 4]>,
}

A struct representing a WebSocket frame header.

Fields

is_final: bool

Indicates that the frame is the last one of a possibly fragmented message.

rsv1: bool

Reserved for protocol extensions.

E.g. for per-message-deflate compression (RFC 7692) it is used to indicate whether or not the message is “compressed”.

rsv2: bool

Reserved for protocol extensions.

rsv3: bool

Reserved for protocol extensions.

opcode: OpCode

WebSocket protocol opcode.

mask: Option<[u8; 4]>

A frame mask, if any.

Implementations

impl FrameHeader

pub fn parse( cursor: &mut Cursor<impl AsRef<[u8]>>, ) -> Result<Option<(FrameHeader, u64)>, ProtocolError>

Parse a header from an input stream. Returns None if insufficient data and does not consume anything in this case. Payload size is returned along with the header.

pub fn len(&self, length: u64) -> usize

Get the size of the header formatted with given payload length.

pub fn format( &self, length: u64, output: &mut impl Write, ) -> Result<(), ProtocolError>

Format a header for given payload size.

Trait Implementations

impl Clone for FrameHeader

fn clone(&self) -> FrameHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameHeader

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

Formats the value using the given formatter.

impl Default for FrameHeader

fn default() -> FrameHeader

Returns the “default value” for a type.

impl PartialEq for FrameHeader

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

impl StructuralPartialEq for FrameHeader