Struct lightws::frame::FrameHead

pub struct FrameHead {
    pub fin: Fin,
    pub opcode: OpCode,
    pub mask: Mask,
    pub length: PayloadLen,
}

Websocket frame head.

Fields

fin: Fin

opcode: OpCode

mask: Mask

length: PayloadLen

Implementations

impl FrameHead

pub const fn new( fin: Fin, opcode: OpCode, mask: Mask, length: PayloadLen ) -> Self

Constructor.

pub fn encode(&self, buf: &mut [u8]) -> Result<usize, FrameError>

Encode to provided buffer, return the count of written bytes.

Caller should ensure there is enough space to write, otherwise a FrameError::NotEnoughCapacity error will be returned.

pub unsafe fn encode_unchecked(&self, buf: &mut [u8]) -> usize

Unchecked version of encode.

Safety

Caller must ensure there is enough space to write, otherwise it is Undefined Behavior!

pub fn decode(buf: &[u8]) -> Result<(Self, usize), FrameError>

Parse from provided buffer, returns FrameHead and the count of read bytes.

If there is not enough data to parse, a FrameError::NotEnoughData error will be returned.

Trait Implementations

impl Clone for FrameHead

fn clone(&self) -> FrameHead

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameHead

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

Formats the value using the given formatter.

impl PartialEq for FrameHead

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FrameHead

impl Eq for FrameHead

impl StructuralEq for FrameHead

impl StructuralPartialEq for FrameHead