Struct ws_tool::frame::Frame

pub struct Frame(_);

websocket data frame

Implementations

impl Frame

pub fn fin(&self) -> bool

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

pub fn rsv1(&self) -> bool

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

pub fn rsv2(&self) -> bool

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

pub fn rsv3(&self) -> bool

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

pub fn opcode(&self) -> OpCode

return frame opcode

pub fn mask(&self) -> bool

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 payload_len(&self) -> u64

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

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

pub fn payload_data_unmask(&self) -> Bytes

return unmask(if masked) payload data

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

impl Frame

helper construct methods

pub fn new_with_opcode(opcode: OpCode) -> Self

pub fn new_with_payload(opcode: OpCode, payload: &[u8]) -> Self

pub fn set_payload(&mut self, payload: &[u8])

set frame payload

NOTE! avoid calling this method multi times, since it need to calculate mask every time

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

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Frame> for WebSocketFrameEncoder

type Error = WsError

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl Encoder<Frame> for WebSocketFrameCodec

type Error = WsError

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl SplitSocket<Frame, Frame, WebSocketFrameEncoder, WebSocketFrameDecoder> for Framed<WsStream, WebSocketFrameCodec>

fn split(
    self
) -> (FramedRead<ReadHalf<WsStream>, WebSocketFrameDecoder>, FramedWrite<WriteHalf<WsStream>, WebSocketFrameEncoder>)