Struct ws_tool::frame::HeaderViewMut

pub struct HeaderViewMut<'a>(_);

mutable frame header

Implementations

impl<'a> HeaderViewMut<'a>

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 mask(&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 payload_idx(&self) -> (usize, usize)

return (headerlen, the whole frame len)

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) -> usize

set header payload lens

pub fn set_masking_key(&mut self, key: [u8; 4])

key header mask key

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

auto generate mask key and apply it

pub fn empty_payload(
    fin: bool,
    rsv1: bool,
    rsv2: bool,
    rsv3: bool,
    opcode: OpCode,
    mask: bool,
    payload_len: usize
) -> BytesMut

return bytes contains expected frame header

pub fn config(
    fin: bool,
    rsv1: bool,
    rsv2: bool,
    rsv3: bool,
    opcode: OpCode,
    mask: bool,
    payload_len: u64,
    buf: &mut BytesMut
)

config mut buf as a valid header

NOTE this operation will override buf content, and try to extend if there is no enough len

Trait Implementations

impl<'a> Debug for HeaderViewMut<'a>

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

Formats the value using the given formatter.