Skip to main content

ClientMessage

Enum ClientMessage 

Source
#[non_exhaustive]
pub enum ClientMessage<'a> { Event(Cow<'a, Event>), Req { subscription_id: Cow<'a, SubscriptionId>, filters: Cow<'a, [Filter]>, }, Count { subscription_id: Cow<'a, SubscriptionId>, filters: Cow<'a, [Filter]>, }, Close(Cow<'a, SubscriptionId>), Auth(Cow<'a, Event>), NegOpen { subscription_id: Cow<'a, SubscriptionId>, filter: Cow<'a, Filter>, message: Cow<'a, str>, }, NegMsg { subscription_id: Cow<'a, SubscriptionId>, message: Cow<'a, str>, }, NegClose(Cow<'a, SubscriptionId>), }
Expand description

Client → relay messages (NIP-01 + NIP-42 AUTH + NIP-45 COUNT + NIP-77).

Variants (Non-exhaustive)§

This enum is marked as 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(Cow<'a, Event>)

["EVENT", <event>] — publish a signed event.

§

Req

["REQ", <id>, <filter>, ...] — open a subscription.

Fields

§subscription_id: Cow<'a, SubscriptionId>

Subscription id.

§filters: Cow<'a, [Filter]>

At least one filter on the wire; encode of an empty slice emits ["REQ","<id>"] unchanged.

§

Count

["COUNT", <id>, <filter>, ...] — a NIP-45 count request.

Fields

§subscription_id: Cow<'a, SubscriptionId>

Subscription id.

§filters: Cow<'a, [Filter]>
§

Close(Cow<'a, SubscriptionId>)

["CLOSE", <id>] — close a subscription.

§

Auth(Cow<'a, Event>)

["AUTH", <event>] — a NIP-42 kind-22242 auth event.

§

NegOpen

["NEG-OPEN", <id>, <filter>, <hex>] — open a NIP-77 sync.

Fields

§subscription_id: Cow<'a, SubscriptionId>

Subscription id.

§filter: Cow<'a, Filter>

The sync filter.

§message: Cow<'a, str>

The initial negentropy message (non-empty, even-length hex).

§

NegMsg

["NEG-MSG", <id>, <hex>] — continue a NIP-77 sync.

Fields

§subscription_id: Cow<'a, SubscriptionId>

Subscription id.

§message: Cow<'a, str>

The negentropy message (non-empty, even-length hex).

§

NegClose(Cow<'a, SubscriptionId>)

["NEG-CLOSE", <id>] — end a NIP-77 sync.

Implementations§

Source§

impl ClientMessage<'_>

Source

pub fn to_json(&self) -> String

The canonical NIP-01 JSON wire form.

Source

pub fn from_json(raw: &str) -> Result<ClientMessage<'static>>

Parses a client → relay JSON message.

§Errors

Error::InvalidJson when the text is not JSON, Error::NotAMessageArray when it is not a non-empty array starting with the type string, Error::UnknownType for an unrecognized type, Error::InvalidMessage for wrong arity or field types, Error::InvalidPayload when an embedded event or filter fails wire validation, Error::InvalidSubscriptionId for a bad subscription id, Error::ObsoleteNegOpen for the 5-element NEG-OPEN, and Error::InvalidNegMessage for malformed NEG hex.

Source

pub fn into_owned(self) -> ClientMessage<'static>

Converts every borrowed field to owned, giving a 'static message.

Trait Implementations§

Source§

impl<'a> Clone for ClientMessage<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for ClientMessage<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a> Eq for ClientMessage<'a>

Source§

impl<'a> PartialEq for ClientMessage<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ClientMessage<'_>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<'a> StructuralPartialEq for ClientMessage<'a>

Auto Trait Implementations§

§

impl<'a> Forget for ClientMessage<'a>

§

impl<'a> Freeze for ClientMessage<'a>

§

impl<'a> Move for ClientMessage<'a>

§

impl<'a> RefUnwindSafe for ClientMessage<'a>

§

impl<'a> Send for ClientMessage<'a>

§

impl<'a> Sync for ClientMessage<'a>

§

impl<'a> Unpin for ClientMessage<'a>

§

impl<'a> UnsafeUnpin for ClientMessage<'a>

§

impl<'a> UnwindSafe for ClientMessage<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.