Enum RelayFrame 

pub enum RelayFrame {
    Subscribe {
        topic: String,
    },
    Unsubscribe {
        topic: String,
    },
    Publish {
        topic: String,
        data: Vec<u8>,
    },
    SubAck {
        topic: String,
    },
    Event {
        topic: String,
        data: Vec<u8>,
    },
}

A frame on the relay WebSocket. Client→relay: Subscribe/Unsubscribe/ Publish. Relay→client: SubAck/Event.

Variants

Subscribe

Client → relay: start receiving Events for topic.

Fields

topic: String

Unsubscribe

Client → relay: stop receiving topic.

Fields

topic: String

Publish

Client → relay: deliver data to every subscriber of topic.

Fields

topic: String

data: Vec<u8>

SubAck

Relay → client: acknowledges a Subscribe is registered (so a publish that races a subscribe cannot be missed — the client awaits this).

Fields

topic: String

Event

Relay → client: a published message on a topic the client subscribes to.

Fields

topic: String

data: Vec<u8>

Implementations

impl RelayFrame

pub fn to_bytes(&self) -> Vec<u8>

Serialize to the bytes that cross the WebSocket (a binary message).

pub fn from_bytes(bytes: &[u8]) -> Option<RelayFrame>

Deserialize a frame from WebSocket bytes; None on a malformed frame.

Trait Implementations

impl Clone for RelayFrame

fn clone(&self) -> RelayFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelayFrame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelayFrame

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RelayFrame

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RelayFrame

impl StructuralPartialEq for RelayFrame