Enum Message 

pub enum Message {
    Text(String),
    Binary(Vec<u8>),
    Ping(Vec<u8>),
    Pong(Vec<u8>),
    Close(Option<CloseFrame>),
}

Variants

Text(String)

Binary(Vec<u8>)

Ping(Vec<u8>)

Pong(Vec<u8>)

Close(Option<CloseFrame>)

None when the peer closed without a status code, which is legal.

Implementations

impl Message

pub fn text(body: impl Into<String>) -> Message

pub fn json(value: &Json) -> Message

A JSON message. The broadcasting protocol is built entirely out of these.

pub fn close(code: CloseCode, reason: impl Into<String>) -> Message

pub fn as_text(&self) -> Option<&str>

pub fn as_bytes(&self) -> &[u8]

pub fn is_data(&self) -> bool

Text or binary — the messages an application actually cares about.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn kind(&self) -> &'static str

A stable label for instrumentation. Never the payload itself: a socket carrying chat or auth tokens must not leak them into Telescope.

pub fn into_frame(self) -> Frame

The frame a server writes for this message: final, and never masked.

pub fn from_data(opcode: OpCode, payload: Vec<u8>) -> WsResult<Message>

Turn a reassembled payload into a message.

Text is validated here rather than at the frame layer, because a message split across fragments is only valid UTF-8 once every fragment has arrived — a multi-byte character is allowed to straddle the boundary.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Eq for Message

impl From<&str> for Message

fn from(body: &str) -> Message

Converts to this type from the input type.

impl From<Json> for Message

fn from(value: Json) -> Message

Converts to this type from the input type.

impl From<String> for Message

fn from(body: String) -> Message

Converts to this type from the input type.

impl From<Vec<u8>> for Message

fn from(bytes: Vec<u8>) -> Message

Converts to this type from the input type.

impl PartialEq for Message

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Message