Enum Message 

#[non_exhaustive]
pub enum Message {
    Request {
        id: String,
        method: Method,
        params: Vec<String>,
    },
    Response {
        id: String,
        result: Option<String>,
        error: Option<String>,
    },
}

Available on crate feature nip46 only.

Wire envelope: a request or a response.

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.

Request

Request frame.

Fields

id: String

Caller-chosen identifier; the response carries the same id so the requester can match them up.

method: Method

Method to invoke.

params: Vec<String>

Wire-format params (each element pre-stringified).

Response

Response frame.

Fields

id: String

Matches the id of the originating Self::Request.

result: Option<String>

Result slot — always present in the JSON, possibly null.

error: Option<String>

Error slot — always present in the JSON, possibly null.

Implementations

impl Message

pub fn request(id: impl Into<String>, request: &Request) -> Self

Build a request envelope from a typed Request and an arbitrary id (typically a random u32 or a UUID).

pub fn response(id: impl Into<String>, response: Response) -> Self

Build a response envelope from a typed Response and the originating request id.

pub fn id(&self) -> &str

Borrow the envelope id (matches across request/response).

pub fn into_request(self) -> Result<Request, Nip46Error>

Decode a Self::Request envelope into a typed Request.

Errors

Returns Nip46Error::WrongMessageKind when the envelope is actually a response, and forwards every parse error from Request::from_wire.

pub fn into_response(self, method: Method) -> Result<Response, Nip46Error>

Decode a Self::Response envelope into a typed Response.

Errors

Returns Nip46Error::WrongMessageKind when the envelope is actually a request, and forwards every parse error from Response::from_wire.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Message

impl PartialEq for Message

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Message

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 Message