Enum nostr_sdk::ClientMessage

pub enum ClientMessage {
    Event(Box<Event, Global>),
    Req {
        subscription_id: SubscriptionId,
        filters: Vec<Filter, Global>,
    },
    Count {
        subscription_id: SubscriptionId,
        filters: Vec<Filter, Global>,
    },
    Close(SubscriptionId),
    Auth(Box<Event, Global>),
}

Messages sent by clients, received by relays

Variants

Event(Box<Event, Global>)

Event

Req

Fields

subscription_id: SubscriptionId

Subscription ID

filters: Vec<Filter, Global>

Filters

Req

Count

Fields

subscription_id: SubscriptionId

Subscription ID

filters: Vec<Filter, Global>

Filters

Count

https://github.com/nostr-protocol/nips/blob/master/45.md

Close(SubscriptionId)

Close

Auth(Box<Event, Global>)

Auth

Implementations

impl ClientMessage

pub fn new_event(event: Event) -> ClientMessage

Create new EVENT message

pub fn new_req( subscription_id: SubscriptionId, filters: Vec<Filter, Global> ) -> ClientMessage

Create new REQ message

pub fn new_count( subscription_id: SubscriptionId, filters: Vec<Filter, Global> ) -> ClientMessage

Create new COUNT message

pub fn close(subscription_id: SubscriptionId) -> ClientMessage

Create new CLOSE message

pub fn new_auth(event: Event) -> ClientMessage

Create new AUTH message

pub fn is_event(&self) -> bool

Check if is an EVENT message

pub fn is_req(&self) -> bool

Check if is an REQ message

pub fn is_close(&self) -> bool

Check if is an CLOSE message

pub fn as_value(&self) -> Value

Serialize as Value

pub fn as_json(&self) -> String

Serialize ClientMessage as JSON string

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

Deserialize from Value

pub fn from_value_with_ctx<C>( secp: &Secp256k1<C>, msg: Value ) -> Result<ClientMessage, MessageHandleError>where C: Verification,

Deserialize from Value

pub fn from_json<S>(msg: S) -> Result<ClientMessage, MessageHandleError>where S: Into<String>,

Deserialize ClientMessage from JSON string

pub fn from_json_with_ctx<C, S>( secp: &Secp256k1<C>, msg: S ) -> Result<ClientMessage, MessageHandleError>where C: Verification, S: Into<String>,

Deserialize ClientMessage from JSON string

Trait Implementations

impl Clone for ClientMessage

fn clone(&self) -> ClientMessage

Returns a copy 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D ) -> Result<ClientMessage, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<ClientMessage> for ClientMessage

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

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ClientMessage

impl StructuralEq for ClientMessage

impl StructuralPartialEq for ClientMessage