Struct Frame 

pub struct Frame {
    pub message: Message,
    /* private fields */
}

Frame structure from websockets connection

Fields

message: Message

Inner message

Implementations

impl Frame

pub const FIN_RSV: u8 = 128u8

FIN RSV bytes

pub const OP_CODE_CONTINUATION: u8 = 0u8

Operation code for a continuation request

pub const OP_CODE_TEXT: u8 = 1u8

Operation code for a text message

pub const OP_CODE_BINARY: u8 = 2u8

Operation code for a binary message

pub const OP_CODE_CLOSE: u8 = 8u8

Operation code for a close request message

pub const OP_CODE_PING: u8 = 9u8

Operation code for a ping message

pub const OP_CODE_PONG: u8 = 10u8

Operation code for a pong message

pub fn op_code(&self) -> u8

Returns the OP CODE of the frame as a u8, where the last 4 bits contain the OP CODE

pub fn parse<A: AsRef<[u8]>>(content: A) -> Result<Frame, FrameParseError>

Attempts to parse a frame from a stream of bytes

pub fn text<A: Into<String>>(text: A) -> Frame

Creates a text frame

pub fn ping<A: Into<Vec<u8>>>(payload: A) -> Frame

Creates a ping message with the given application data

pub fn pong<A: Into<Vec<u8>>>(payload: A) -> Frame

Creates a pong message with the given application data

pub fn binary<A: Into<Vec<u8>>>(binary: A) -> Frame

Creates a binary frame

pub fn close() -> Frame

Creates a close frame

pub fn get_message(&self) -> &Message

Takes the frame and returns the contained message, if any

pub fn is_close(&self) -> bool

Indicates if this frame is a closing frame

Trait Implementations

impl From<Frame> for Message

fn from(source: Frame) -> Message

Converts to this type from the input type.

impl From<Frame> for Vec<u8>

fn from(source: Frame) -> Vec<u8>

Converts to this type from the input type.