Struct actix_web::ws::Frame

pub struct Frame { /* private fields */ }

A struct representing a WebSocket frame.

Implementations

impl Frame

pub fn unpack(self) -> (bool, OpCode, Binary)

Destruct frame

pub fn close(reason: Option<CloseReason>, genmask: bool) -> FramedMessage

Create a new Close control frame.

pub fn parse<S>(
    pl: &mut PayloadBuffer<S>,
    server: bool,
    max_size: usize
) -> Poll<Option<Frame>, ProtocolError>where
    S: Stream<Item = Bytes, Error = PayloadError>,

Parse the input stream into a frame.

pub fn parse_close_payload(payload: &Binary) -> Option<CloseReason>

Parse the payload of a close frame.

pub fn message<B: Into<Binary>>(
    data: B,
    code: OpCode,
    finished: bool,
    genmask: bool
) -> FramedMessage

Generate binary representation

Trait Implementations

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.