Enum Message

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

WebSocket message type

Note: This enum holds owned data (String, Vec) which prevents true zero-copy operations with memory pools. For high-performance scenarios requiring zero-copy, consider using the lower-level yawc::FrameView directly or implementing a custom message type that holds buffer handles instead of owned data.

Variants

Text(String)

Text message

Binary(Vec<u8>)

Binary message

Ping(Vec<u8>)

Ping message

Pong(Vec<u8>)

Pong message

Close(Option<(u16, String)>)

Close message

Frame(FrameView)

Raw frame (for compatibility)

Implementations

impl Message

pub fn text<S: Into<String>>(text: S) -> Self

Create a text message

pub fn binary<V: Into<Vec<u8>>>(data: V) -> Self

Create a binary message

pub fn ping<V: Into<Vec<u8>>>(data: V) -> Self

Create a ping message

pub fn pong<V: Into<Vec<u8>>>(data: V) -> Self

Create a pong message

pub fn close(code: u16, reason: &str) -> Self

Create a close message

pub const fn is_text(&self) -> bool

Check if this is a text message

pub const fn is_binary(&self) -> bool

Check if this is a binary message

pub const fn is_ping(&self) -> bool

Check if this is a ping message

pub const fn is_pong(&self) -> bool

Check if this is a pong message

pub const fn is_close(&self) -> bool

Check if this is a close message

pub const fn is_frame(&self) -> bool

Check if this is a frame message

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

Get the text content if this is a text message

pub fn as_binary(&self) -> Option<&[u8]>

Get the binary content if this is a binary message

pub fn to_frame_view(self) -> FrameView

Convert to yawc FrameView

pub fn from_frame_view(frame: FrameView) -> Self

Create from yawc FrameView

impl Message

pub const fn message_type(&self) -> MessageType

Get the message type

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

const 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 Display for Message

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

Formats the value using the given formatter.