Struct JsonRpcMessage 

pub struct JsonRpcMessage {
    pub jsonrpc: String,
    pub id: Option<Value>,
    pub method: Option<String>,
    pub params: Option<Value>,
    pub result: Option<Value>,
    pub error: Option<JsonRpcError>,
}

A JSON-RPC 2.0 message: request, response, or notification depending on which fields are set.

id is a serde_json::Value rather than an integer so any id a host uses (number or string, both legal) round-trips back verbatim in the response.

Fields

jsonrpc: String

Always "2.0".

id: Option<Value>

Request/response correlation id; absent on notifications.

method: Option<String>

Method name; set on requests and notifications.

params: Option<Value>

Method parameters.

result: Option<Value>

Success payload; set on responses.

error: Option<JsonRpcError>

Failure payload; set on error responses.

Implementations

impl JsonRpcMessage

pub fn response(id: Value, result: &impl Serialize) -> Self

A successful response to the request identified by id.

result is always one of this module’s protocol types, whose serialization is infallible; a failure would be a bug here rather than a runtime condition, so it degrades to JSON null instead of propagating.

pub fn error_response(id: Value, code: i32, message: impl Into<String>) -> Self

An error response to the request identified by id.

pub fn notification(method: impl Into<String>, params: &impl Serialize) -> Self

An outbound notification (no id, no response expected).

pub fn request( id: Value, method: impl Into<String>, params: &impl Serialize, ) -> Self

An outbound request (agent → client), e.g. session/request_permission.

pub fn is_notification(&self) -> bool

Whether this message is a notification: a method call with no id, which must never be answered.

Trait Implementations

impl Clone for JsonRpcMessage

fn clone(&self) -> JsonRpcMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonRpcMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsonRpcMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JsonRpcMessage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for JsonRpcMessage

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 JsonRpcMessage