Struct FrameHeader

pub struct FrameHeader { /* private fields */ }

Describes an individual frame within a WebSocket message at a low level.

The frame header is a lower level detail of the WebSocket protocol. At the application level, use Message structs and the MessageCodec.

Implementations

impl FrameHeader

pub fn new( fin: bool, rsv: u8, opcode: u8, mask: Option<Mask>, data_len: DataLength, ) -> Self

Returns a FrameHeader struct.

pub fn fin(&self) -> bool

Returns the WebSocket FIN bit, which indicates that this is the last frame in the message.

pub fn rsv(&self) -> u8

Returns the WebSocket RSV1, RSV2 and RSV3 bits.

The RSV bits may be used by extensions to the WebSocket protocol not exposed by this crate.

pub fn opcode(&self) -> u8

Returns the WebSocket opcode, which defines the interpretation of the frame payload data.

pub fn mask(&self) -> Option<Mask>

Returns the frame’s mask.

pub fn data_len(&self) -> DataLength

Returns the length of the payload data that follows this header.

pub fn header_len(&self) -> usize

Returns the total length of the frame header.

The frame header is between 2 bytes and 10 bytes in length, depending on the presence of a mask and the length of the payload data.

Trait Implementations

impl Clone for FrameHeader

fn clone(&self) -> FrameHeader

Returns a copy 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

Formats the value using the given formatter.

impl<'a> Encoder<&'a FrameHeader> for FrameHeaderCodec

type Error = Box<dyn Error + Sync + Send>

The type of encoding errors.

fn encode(&mut self, item: &'a FrameHeader, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.

impl Encoder<FrameHeader> for FrameHeaderCodec

type Error = Box<dyn Error + Sync + Send>

The type of encoding errors.

fn encode(&mut self, item: FrameHeader, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.

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 StructuralPartialEq for FrameHeader