Enum ProtocolEvent 

pub enum ProtocolEvent {
    Joined {
        topic: String,
        reference: String,
        response: Payload,
    },
    JoinError {
        topic: String,
        reference: String,
        response: Payload,
    },
    Left {
        topic: String,
        reference: String,
        response: Payload,
    },
    Reply {
        topic: String,
        event: String,
        reference: String,
        status: ReplyStatus,
        response: Payload,
    },
    Message(Frame),
    ChannelClosed {
        topic: String,
        payload: Payload,
    },
    ChannelError {
        topic: String,
        payload: Payload,
    },
    HeartbeatAck {
        reference: String,
        status: ReplyStatus,
    },
    RequestInterrupted {
        topic: String,
        event: String,
        reference: String,
    },
    StaleMessage(Frame),
    UnmatchedReply(Frame),
}

Semantic event produced from an incoming Phoenix frame or connection reset.

Variants

Joined

A topic join succeeded.

Fields

topic: String

Joined topic.

reference: String

Correlated request reference.

response: Payload

Server join response.

JoinError

A topic join was rejected.

Fields

topic: String

Rejected topic.

reference: String

Correlated request reference.

response: Payload

Server error response.

Left

A topic leave completed.

Fields

topic: String

Left topic.

reference: String

Correlated request reference.

response: Payload

Server leave response.

Reply

An application push received a reply.

Fields

topic: String

Topic to which the push was sent.

event: String

Application event name.

reference: String

Correlated request reference.

status: ReplyStatus

Phoenix reply status.

response: Payload

Server response payload.

Message(Frame)

An application or Presence message that was not a correlated reply.

ChannelClosed

The server sent phx_close for a topic.

Fields

topic: String

Closed topic.

payload: Payload

Close payload.

ChannelError

The server sent phx_error for a topic.

Fields

topic: String

Errored topic.

payload: Payload

Error payload.

HeartbeatAck

The server acknowledged a heartbeat.

Fields

reference: String

Correlated heartbeat reference.

status: ReplyStatus

Heartbeat reply status.

RequestInterrupted

A pending request was interrupted by transport reset.

Fields

topic: String

Topic on which the request was active.

event: String

Join, leave, or application event name.

reference: String

Interrupted request reference.

StaleMessage(Frame)

A frame belonged to an earlier join generation.

UnmatchedReply(Frame)

A reply had no matching pending operation.

Trait Implementations

impl Clone for ProtocolEvent

fn clone(&self) -> ProtocolEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolEvent

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

Formats the value using the given formatter.

impl PartialEq for ProtocolEvent

fn eq(&self, other: &ProtocolEvent) -> 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 ProtocolEvent