Enum Frame 

pub enum Frame {
    Text(String),
    Binary(Bytes),
}

A wire message: the union of WebSocket text and binary data frames.

Conversions are zero-copy where the transport already owns the data: String, &str, and Bytes all move into a Frame without re-encoding. Vec<u8> and borrowed &[u8] copy once.

Frame implements Serialize/Deserialize, so it can ride the generic crate::hub::BroadcastHub<Frame>; in JSON form binary payloads are represented as byte arrays and — per the security posture below — are only ever decoded back into Frame::Binary, never parsed as text.

Example

use ws_kit::codec::Frame;

let text = Frame::from("hello");          // &str — one UTF-8 copy
let owned = Frame::from(String::from("hi")); // String — zero-copy move
let bin = Frame::from(vec![0u8, 1, 2]);   // Vec<u8> — becomes Binary
assert!(matches!(text, Frame::Text(_)));
assert!(matches!(bin, Frame::Binary(_)));

Variants

Text(String)

A UTF-8 text frame (WebSocket opcode 0x1).

Binary(Bytes)

An opaque binary frame (WebSocket opcode 0x2). Never parsed as text/JSON by ws-kit — see the security posture.

Implementations

impl Frame

pub fn binary(data: impl Into<Bytes>) -> Self

Construct a Binary frame from anything Bytes converts from.

pub fn len(&self) -> usize

Payload length in bytes (UTF-8 length for text).

pub fn is_empty(&self) -> bool

True when the payload is empty.

pub fn is_text(&self) -> bool

True for Frame::Text.

pub fn is_binary(&self) -> bool

True for Frame::Binary.

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

Payload as bytes (UTF-8 for text), without consuming the frame.

pub fn into_bytes(self) -> Bytes

Take the payload as owned bytes, consuming the frame.

pub fn into_text(self) -> Result<String, WsError>

Interpret the payload as UTF-8 text (binary is rejected, not sniffed).

Trait Implementations

impl Clone for Frame

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 Frame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frame

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Frame

impl From<&[u8]> for Frame

fn from(v: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Frame

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Frame

fn from(b: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for Frame

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Frame

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Frame

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Frame