Enum ClientMessage 

#[non_exhaustive]
pub enum ClientMessage {
    Event(Event),
    Req {
        subscription_id: SubscriptionId,
        filters: Vec<Filter>,
    },
    Close(SubscriptionId),
    Auth(Event),
    Count {
        subscription_id: SubscriptionId,
        filter: Filter,
    },
    NegOpen {
        subscription_id: SubscriptionId,
        filter: Filter,
        initial_message: String,
    },
    NegMsg {
        subscription_id: SubscriptionId,
        message: String,
    },
    NegClose {
        subscription_id: SubscriptionId,
    },
}

Messages sent from a client to a relay.

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(Event)

Publish an event to the relay.

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

Req

Open or replace a subscription with one or more filters.

Wire form: ["REQ", <subscription_id>, <filter1>, <filter2>, …].

Fields

subscription_id: SubscriptionId

Subscription identifier.

filters: Vec<Filter>

Filters that the relay must AND together when resolving.

Close(SubscriptionId)

Close a subscription.

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

Auth(Event)

Reply to a NIP-42 challenge with a signed kind-22242 event.

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

Count

Count events matching a filter (NIP-45).

Wire form: ["COUNT", <subscription_id>, <filter>].

Fields

subscription_id: SubscriptionId

Subscription identifier.

filter: Filter

Counting filter.

NegOpen

Open a NIP-77 Negentropy reconciliation session.

Wire form (current protocol): ["NEG-OPEN", <subscription_id>, <filter>, <initial_message_hex>].

Fields

subscription_id: SubscriptionId

Subscription identifier the relay will use for follow-up NEG-MSG / NEG-ERR frames.

filter: Filter

Filter that scopes the reconciliation.

initial_message: String

Initial negentropy message, lowercase hex-encoded.

NegMsg

One step of an in-flight NIP-77 reconciliation.

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

Fields

subscription_id: SubscriptionId

Subscription identifier the client picked in the matching Self::NegOpen.

message: String

Reconciliation payload, lowercase hex-encoded.

NegClose

Close a NIP-77 reconciliation session.

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

Fields

subscription_id: SubscriptionId

Subscription identifier to release on the relay side.

Implementations

impl ClientMessage

pub const fn event(event: Event) -> Self

Convenience constructor for ClientMessage::Event.

pub const fn req(subscription_id: SubscriptionId, filters: Vec<Filter>) -> Self

Convenience constructor for ClientMessage::Req.

pub const fn close(subscription_id: SubscriptionId) -> Self

Convenience constructor for ClientMessage::Close.

pub const fn auth(event: Event) -> Self

Convenience constructor for ClientMessage::Auth.

pub const fn count(subscription_id: SubscriptionId, filter: Filter) -> Self

Convenience constructor for ClientMessage::Count.

pub const fn neg_open( subscription_id: SubscriptionId, filter: Filter, initial_message: String, ) -> Self

Convenience constructor for ClientMessage::NegOpen.

pub const fn neg_msg(subscription_id: SubscriptionId, message: String) -> Self

Convenience constructor for ClientMessage::NegMsg.

pub const fn neg_close(subscription_id: SubscriptionId) -> Self

Convenience constructor for ClientMessage::NegClose.

Trait Implementations

impl Clone for ClientMessage

fn clone(&self) -> ClientMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientMessage

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClientMessage

impl PartialEq for ClientMessage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ClientMessage

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 ClientMessage