Struct websocket::dataframe::DataFrame

pub struct DataFrame {
    pub finished: bool,
    pub reserved: [bool; 3],
    pub opcode: Opcode,
    pub data: Vec<u8>,
}

Represents a WebSocket data frame.

The data held in a DataFrame is never masked. Masking/unmasking is done when sending and receiving the data frame,

This DataFrame, unlike the standard Message implementation (which also implements the DataFrame trait), owns its entire payload. This means that calls to payload don’t allocate extra memory (again unlike the default Message implementation).

Fields

finished: bool

Whether or no this constitutes the end of a message

reserved: [bool; 3]

The reserved portion of the data frame (RFC6455 5.2)

opcode: Opcode

The opcode associated with this data frame

data: Vec<u8>

The payload associated with this data frame

Implementations

impl DataFrame

pub fn new(finished: bool, opcode: Opcode, data: Vec<u8>) -> DataFrame

Creates a new DataFrame.

pub fn read_dataframe_body( header: DataFrameHeader, body: Vec<u8>, should_be_masked: bool ) -> Result<DataFrame, WebSocketError>

Take the body and header of a dataframe and combine it into a single Dataframe struct. A websocket message can be made up of many individual dataframes, use the methods from the Message or OwnedMessage structs to take many of these and create a websocket message.

pub fn read_dataframe<R>( reader: &mut R, should_be_masked: bool ) -> Result<DataFrame, WebSocketError>

where R: Read,

Reads a DataFrame from a Reader.

pub fn read_dataframe_with_limit<R>( reader: &mut R, should_be_masked: bool, limit: usize ) -> Result<DataFrame, WebSocketError>

where R: Read,

Reads a DataFrame from a Reader, or error out if header declares exceeding limit you specify

Trait Implementations

impl Clone for DataFrame

fn clone(&self) -> DataFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataFrame for DataFrame

fn is_last(&self) -> bool

Is this dataframe the final dataframe of the message?

fn opcode(&self) -> u8

What type of data does this dataframe contain?

fn reserved(&self) -> &[bool; 3]

Reserved bits of this dataframe

fn size(&self) -> usize

How long (in bytes) is this dataframe’s payload

fn write_payload(&self, socket: &mut dyn Write) -> Result<(), WebSocketError>

Write the payload to a writer

fn take_payload(self) -> Vec<u8>

Takes the payload out into a vec

fn frame_size(&self, masked: bool) -> usize

Get’s the size of the entire dataframe in bytes, i.e. header and payload.

fn write_to( &self, writer: &mut dyn Write, mask: bool ) -> Result<(), WebSocketError>

Writes a DataFrame to a Writer.

impl Debug for DataFrame

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

Formats the value using the given formatter.

impl PartialEq for DataFrame

fn eq(&self, other: &DataFrame) -> 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 StructuralPartialEq for DataFrame