Struct parity_ws::Frame

pub struct Frame { /* fields omitted */ }

A struct representing a WebSocket frame.

Implementations

impl Frame

pub fn len(&self) -> usize

Get the length of the frame. This is the length of the header + the length of the payload.

pub fn is_empty(&self) -> bool

Return false: a frame is never empty since it has a header.

pub fn is_final(&self) -> bool

Test whether the frame is a final frame.

pub fn has_rsv1(&self) -> bool

Test whether the first reserved bit is set.

pub fn has_rsv2(&self) -> bool

Test whether the second reserved bit is set.

pub fn has_rsv3(&self) -> bool

Test whether the third reserved bit is set.

pub fn opcode(&self) -> OpCode

Get the OpCode of the frame.

pub fn is_control(&self) -> bool

Test whether this is a control frame.

pub fn payload(&self) -> &Vec<u8>

Get a reference to the frame’s payload.

pub fn set_final(&mut self, is_final: bool) -> &mut Frame

Make this frame a final frame.

pub fn set_rsv1(&mut self, has_rsv1: bool) -> &mut Frame

Set the first reserved bit.

pub fn set_rsv2(&mut self, has_rsv2: bool) -> &mut Frame

Set the second reserved bit.

pub fn set_rsv3(&mut self, has_rsv3: bool) -> &mut Frame

Set the third reserved bit.

pub fn set_opcode(&mut self, opcode: OpCode) -> &mut Frame

Set the OpCode.

pub fn payload_mut(&mut self) -> &mut Vec<u8>

Edit the frame’s payload.

pub fn into_data(self) -> Vec<u8>

Consume the frame into its payload.

pub fn message(data: Vec<u8>, code: OpCode, finished: bool) -> Frame

Create a new data frame.

pub fn pong(data: Vec<u8>) -> Frame

Create a new Pong control frame.

pub fn ping(data: Vec<u8>) -> Frame

Create a new Ping control frame.

pub fn close(code: CloseCode, reason: &str) -> Frame

Create a new Close control frame.

pub fn parse(
    cursor: &mut Cursor<CappedBuffer>,
    max_payload_length: u64
) -> Result<Option<Frame>>

Parse the input stream into a frame.

pub fn format<W>(&mut self, w: &mut W) -> Result<()> where
    W: Write, 

Write a frame out to a buffer

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

pub 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() -> Frame

Returns the “default value” for a type.

impl Display for Frame

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

Formats the value using the given formatter.