Enum RelayMessage

pub enum RelayMessage {
    Auth(String),
    Closed(SubscriptionId, String),
    Eose(SubscriptionId),
    Event(SubscriptionId, Box<Event>),
    Notice(String),
    Notify(String),
    Ok(Id, bool, String),
    Count(SubscriptionId, CountResult),
}

A message from a relay to a client

Variants

Auth(String)

Used to send authentication challenges

Closed(SubscriptionId, String)

Used to indicate that a subscription was ended on the server side Every ClientMessage::Req may trigger a RelayMessage::Closed response The last parameter may have a colon-terminated machine-readable prefix of: duplicate, pow, blocked, rate-limited, invalid, auth-required, restricted, or error

Eose(SubscriptionId)

End of subscribed events notification

Event(SubscriptionId, Box<Event>)

An event matching a subscription

Notice(String)

A human readable notice for errors and other information

Notify(String)

A human readable notice for the end user

Ok(Id, bool, String)

Used to notify clients if an event was successuful Every ClientMessage::Event will trigger a RelayMessage::OK response The last parameter may have a colon-terminated machine-readable prefix of: duplicate, pow, blocked, rate-limited, invalid, auth-required, restricted or error

Count(SubscriptionId, CountResult)

The results of a COUNT command

Implementations

impl RelayMessage

pub fn why(&self) -> Option<Why>

Translate the machine-readable prefix from the message

Trait Implementations

impl Clone for RelayMessage

fn clone(&self) -> RelayMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelayMessage

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RelayMessage

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

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 RelayMessage

impl StructuralPartialEq for RelayMessage