Skip to main content

JSONRPCResponse

Struct JSONRPCResponse 

Source
pub struct JSONRPCResponse<R = Value, E = JSONRPCError> {
    pub jsonrpc: String,
    pub id: RequestId,
    pub payload: ResponsePayload<R, E>,
}
Expand description

A JSON-RPC response.

§Examples

use pmcp::types::{JSONRPCResponse, RequestId, JSONRPCError};
use pmcp::types::jsonrpc::ResponsePayload;
use serde_json::json;

// Success response
let success: JSONRPCResponse<serde_json::Value, JSONRPCError> = JSONRPCResponse {
    jsonrpc: "2.0".to_string(),
    id: RequestId::from(1i64),
    payload: ResponsePayload::Result(json!({
        "tools": [
            {"name": "calculator", "description": "Perform calculations"},
            {"name": "weather", "description": "Get weather info"}
        ]
    })),
};

// Error response
let error: JSONRPCResponse<serde_json::Value, JSONRPCError> = JSONRPCResponse {
    jsonrpc: "2.0".to_string(),
    id: RequestId::from("req-123".to_string()),
    payload: ResponsePayload::Error(JSONRPCError {
        code: -32602,
        message: "Invalid parameters".to_string(),
        data: Some(json!({"field": "name", "reason": "required"})),
    }),
};

// Using constructors
let ping_response: JSONRPCResponse<serde_json::Value, JSONRPCError> = JSONRPCResponse::success(
    RequestId::from(99i64),
    json!({"status": "pong"})
);

let not_found: JSONRPCResponse<serde_json::Value, JSONRPCError> = JSONRPCResponse::error(
    RequestId::from("missing".to_string()),
    JSONRPCError {
        code: -32601,
        message: "Method not found".to_string(),
        data: None,
    }
);

// Check response types
assert!(success.is_success());
assert!(!success.is_error());
assert!(error.is_error());
assert!(!error.is_success());

Fields§

§jsonrpc: String

Must be “2.0”

§id: RequestId

Request ID this response corresponds to

§payload: ResponsePayload<R, E>

Either result or error must be present

Implementations§

Source§

impl<R, E> JSONRPCResponse<R, E>

Source

pub fn success(id: RequestId, result: R) -> Self

Create a successful response.

Source

pub fn error(id: RequestId, error: E) -> Self

Create an error response.

Source

pub fn is_success(&self) -> bool

Check if this is a successful response.

Source

pub fn is_error(&self) -> bool

Check if this is an error response.

Source

pub fn result(&self) -> Option<&R>

Get the result if this is a successful response.

Source

pub fn get_error(&self) -> Option<&E>

Get the error if this is an error response.

Trait Implementations§

Source§

impl<R: Clone, E: Clone> Clone for JSONRPCResponse<R, E>

Source§

fn clone(&self) -> JSONRPCResponse<R, E>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<R: Debug, E: Debug> Debug for JSONRPCResponse<R, E>

Source§

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

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

impl<'de, R, E> Deserialize<'de> for JSONRPCResponse<R, E>
where R: Deserialize<'de>, E: Deserialize<'de>,

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<R, E> Serialize for JSONRPCResponse<R, E>
where R: Serialize, E: Serialize,

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

Auto Trait Implementations§

§

impl<R, E> Freeze for JSONRPCResponse<R, E>
where R: Freeze, E: Freeze,

§

impl<R, E> RefUnwindSafe for JSONRPCResponse<R, E>

§

impl<R, E> Send for JSONRPCResponse<R, E>
where R: Send, E: Send,

§

impl<R, E> Sync for JSONRPCResponse<R, E>
where R: Sync, E: Sync,

§

impl<R, E> Unpin for JSONRPCResponse<R, E>
where R: Unpin, E: Unpin,

§

impl<R, E> UnsafeUnpin for JSONRPCResponse<R, E>
where R: UnsafeUnpin, E: UnsafeUnpin,

§

impl<R, E> UnwindSafe for JSONRPCResponse<R, E>
where R: UnwindSafe, E: UnwindSafe,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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