Struct Frame

pub struct Frame<'a> {
    pub finished: bool,
    pub opcode: OpCode,
    pub payload: Payload<'a>,
}

WebSocket frame.

Fields

finished: bool

Whether the frame is finished or not.

opcode: OpCode

Opcode of the WebSocket frame.

payload: Payload<'a>

Payload of the WebSocket frame.

Implementations

impl<'a> Frame<'a>

pub fn text(payload: Payload<'a>) -> Self

Create a new text frame.

pub fn binary(payload: Payload<'a>) -> Self

Create a new binary frame.

pub fn close(payload: Payload<'a>) -> Self

Create a new close frame.

Trait Implementations

impl<'a> Clone for Frame<'a>

fn clone(&self) -> Frame<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.

impl<'a> From<Frame<'a>> for Frame<'a>

Available on crate feature fastwebsockets only.

fn from(frame: Frame<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Frame<'a>> for Frame<'a>

Available on crate feature fastwebsockets only.

fn from(frame: Frame<'a>) -> Self

Converts to this type from the input type.

impl From<Packet<'_>> for Frame<'static>

fn from(packet: Packet<'_>) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<Frame<'a>> for Packet<'a>

type Error = WispError

The type returned in the event of a conversion error.

fn try_from(frame: Frame<'a>) -> Result<Self, Self::Error>

Performs the conversion.