Enum nostr::message::relay::RelayMessage

pub enum RelayMessage {
    Event {
        subscription_id: SubscriptionId,
        event: Box<Event>,
    },
    Ok {
        event_id: EventId,
        status: bool,
        message: String,
    },
    EndOfStoredEvents(SubscriptionId),
    Notice {
        message: String,
    },
    Closed {
        subscription_id: SubscriptionId,
        message: String,
    },
    Auth {
        challenge: String,
    },
    Count {
        subscription_id: SubscriptionId,
        count: usize,
    },
    NegMsg {
        subscription_id: SubscriptionId,
        message: String,
    },
    NegErr {
        subscription_id: SubscriptionId,
        code: NegentropyErrorCode,
    },
}

Messages sent by relays, received by clients

Variants

Event

Fields

subscription_id: SubscriptionId

Subscription ID

event: Box<Event>

Event

["EVENT", <subscription_id>, <event JSON>] (NIP01)

Ok

Fields

event_id: EventId

Event ID

status: bool

Status

message: String

Message

["OK", <event_id>, <true|false>, <message>] (NIP01)

EndOfStoredEvents(SubscriptionId)

["EOSE", <subscription_id>] (NIP01)

Notice

Fields

message: String

Message

[“NOTICE”, <message>] (NIP01)

Closed

Fields

subscription_id: SubscriptionId

Subscription ID

message: String

Message

["CLOSED", <subscription_id>, <message>] (NIP01)

Auth

Fields

challenge: String

Challenge

["AUTH", <challenge-string>] (NIP42)

Count

Fields

subscription_id: SubscriptionId

Subscription ID

count: usize

Events count

["COUNT", <subscription_id>, {"count": <integer>}] (NIP45)

NegMsg

Fields

subscription_id: SubscriptionId

Subscription ID

message: String

Message

Negentropy Message

NegErr

Fields

subscription_id: SubscriptionId

Subscription ID

code: NegentropyErrorCode

Error code

Negentropy Error

Implementations

impl RelayMessage

pub fn new_event(subscription_id: SubscriptionId, event: Event) -> Self

Create new EVENT message

pub fn new_notice<S>(message: S) -> Self

where S: Into<String>,

Create new NOTICE message

pub fn new_closed<S>(subscription_id: SubscriptionId, message: S) -> Self

where S: Into<String>,

Create new CLOSED message

pub fn new_eose(subscription_id: SubscriptionId) -> Self

Create new EOSE message

pub fn new_ok<S>(event_id: EventId, status: bool, message: S) -> Self

where S: Into<String>,

Create new OK message

pub fn new_auth<S>(challenge: S) -> Self

where S: Into<String>,

Create new AUTH message

pub fn new_count(subscription_id: SubscriptionId, count: usize) -> Self

Create new EVENT message

pub fn from_value(msg: Value) -> Result<Self, MessageHandleError>

Deserialize RelayMessage from Value

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

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonUtil for RelayMessage

fn from_json<T>(json: T) -> Result<Self, Self::Err>

where T: AsRef<[u8]>,

Deserialize RelayMessage from JSON string

This method NOT verify the event signature!

type Err = MessageHandleError

Error

fn as_json(&self) -> String

Serialize to JSON string

impl Ord for RelayMessage

fn cmp(&self, other: &RelayMessage) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RelayMessage

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RelayMessage

fn partial_cmp(&self, other: &RelayMessage) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= 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 TryFrom<RawRelayMessage> for RelayMessage

type Error = MessageHandleError

The type returned in the event of a conversion error.

fn try_from(raw: RawRelayMessage) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for RelayMessage

impl StructuralEq for RelayMessage

impl StructuralPartialEq for RelayMessage