Struct Header

pub struct Header(/* private fields */);

owned header buf

Implementations

impl Header

pub fn fin(&self) -> bool

get fin bit value

pub fn rsv1(&self) -> bool

get rsv1 bit value

pub fn rsv2(&self) -> bool

get rsv2 bit value

pub fn rsv3(&self) -> bool

get rsv3 bit value

pub fn opcode(&self) -> OpCode

return frame opcode

pub fn masked(&self) -> bool

get mask bit value

pub fn payload_len(&self) -> u64

return payload len

pub fn masking_key(&self) -> Option<[u8; 4]>

get frame mask key

pub fn as_bytes(&self) -> &[u8]

get header as bytes

pub fn set_fin(&mut self, val: bool)

set fin bit

pub fn set_rsv1(&mut self, val: bool)

set rsv1 bit

pub fn set_rsv2(&mut self, val: bool)

set rsv2 bit

pub fn set_rsv3(&mut self, val: bool)

set rsv3 bit

pub fn set_opcode(&mut self, code: OpCode)

set opcode

pub fn set_mask(&mut self, mask: bool)

NOTE if change mask bit after setting payload you need to set payload again to adjust data frame

pub fn set_payload_len(&mut self, len: u64)

set header payload lens TODO do not overlay mask key

pub fn raw(data: BytesMut) -> Self

construct header without checking

pub fn new<M: Into<Option<[u8; 4]>>>( fin: bool, rsv1: bool, rsv2: bool, rsv3: bool, mask_key: M, opcode: OpCode, payload_len: u64, ) -> Self

construct new header

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.