Struct Frame 

pub struct Frame {
    pub join_ref: Option<String>,
    pub reference: Option<String>,
    pub topic: String,
    pub event: String,
    pub payload: Payload,
}

A Phoenix Channels v2 JSON frame.

The serialized representation is [join_ref, ref, topic, event, payload].

Fields

join_ref: Option<String>

Reference of the channel join generation, when present.

reference: Option<String>

Reference used to correlate a push and reply, when present.

topic: String

Channel topic or the special phoenix heartbeat topic.

event: String

Phoenix or application-defined event name.

payload: Payload

JSON, binary, or reply payload carried by the frame.

Implementations

impl Frame

pub fn new( join_ref: Option<String>, reference: Option<String>, topic: impl Into<String>, event: impl Into<String>, payload: impl Into<Payload>, ) -> Self

Creates a protocol frame from its v2 serializer fields.

pub fn encode_text(&self) -> Result<String, FrameCodecError>

Encodes this frame using Phoenix’s JSON v2 representation.

Binary payloads must be encoded with crate::Codec instead.

pub fn decode_text(input: &str) -> Result<Self, FrameCodecError>

Decodes a Phoenix JSON v2 frame.

pub fn route<R: EventRoute>(&self) -> Result<Option<R::Output>, PayloadError>

Decodes this frame’s JSON payload when its event matches R::EVENT.

Returns Ok(None) for a different event.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

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 PartialEq for Frame

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Frame