Enum RelayMessage 

#[non_exhaustive]
pub enum RelayMessage {
    Event {
        subscription_id: SubscriptionId,
        event: Event,
    },
    Ok {
        event_id: EventId,
        accepted: bool,
        message: String,
    },
    EndOfStoredEvents(SubscriptionId),
    Closed {
        subscription_id: SubscriptionId,
        message: String,
    },
    Notice(String),
    Auth(String),
    Count {
        subscription_id: SubscriptionId,
        count: u64,
    },
    NegMsg {
        subscription_id: SubscriptionId,
        message: String,
    },
    NegErr {
        subscription_id: SubscriptionId,
        message: String,
    },
}

Messages sent from a relay to a client.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Event

A subscription event match.

Wire form: ["EVENT", <subscription_id>, <event>].

Fields

subscription_id: SubscriptionId

Subscription identifier originally supplied by the client.

event: Event

The matched event.

Ok

Acknowledgement for a published crate::Event.

Wire form: ["OK", <event_id>, <accepted>, <message>].

Fields

event_id: EventId

Event id the relay is acknowledging.

accepted: bool

true if the event was accepted.

message: String

Human-readable reason. Use MachineReadablePrefix::from_reason to recover a structured reason.

EndOfStoredEvents(SubscriptionId)

End-of-stored-events sentinel: the relay has finished sending stored matches; future events arrive in real time.

Wire form: ["EOSE", <subscription_id>].

Closed

The relay closed the subscription.

Wire form: ["CLOSED", <subscription_id>, <reason>].

Fields

subscription_id: SubscriptionId

Subscription identifier.

message: String

Reason string. Use MachineReadablePrefix::from_reason to recover a structured reason.

Notice(String)

A free-form notice intended for end-user display.

Wire form: ["NOTICE", <message>].

Auth(String)

NIP-42 authentication challenge.

Wire form: ["AUTH", <challenge>].

Count

Count reply for a previously issued COUNT request (NIP-45).

Wire form: ["COUNT", <subscription_id>, {"count": <n>}].

Fields

subscription_id: SubscriptionId

Subscription identifier.

count: u64

Number of matching events.

NegMsg

One step of an in-flight NIP-77 reconciliation, from the relay back to the client.

Wire form: ["NEG-MSG", <subscription_id>, <message_hex>].

Fields

subscription_id: SubscriptionId

Subscription identifier from the original NEG-OPEN.

message: String

Reconciliation payload, lowercase hex-encoded.

NegErr

Terminal error frame for a NIP-77 reconciliation session.

Wire form: ["NEG-ERR", <subscription_id>, <reason>].

Fields

subscription_id: SubscriptionId

Subscription identifier the relay is failing.

message: String

Reason string. Conventional prefixes (e.g. "blocked: …") are observable via MachineReadablePrefix::from_reason.

Trait Implementations

impl Clone for RelayMessage

fn clone(&self) -> RelayMessage

Returns a duplicate 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 Eq for RelayMessage

impl PartialEq for RelayMessage

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for RelayMessage