JsonRpcResponse

Struct JsonRpcResponse 

Source
pub struct JsonRpcResponse {
    pub jsonrpc: String,
    pub result: Option<Value>,
    pub error: Option<Value>,
    pub id: Option<RequestId>,
}
Expand description

JSON-RPC 2.0 Response Message

Represents the response to a JSON-RPC request. Contains either a successful result or error information, but never both (mutual exclusion enforced by JSON-RPC spec).

§JSON-RPC 2.0 Specification Compliance

  • jsonrpc: MUST be exactly “2.0”
  • result: MUST exist and contain the result if the call succeeded (omitted on error)
  • error: MUST exist and contain error details if the call failed (omitted on success)
  • id: MUST be the same as the request that triggered this response, or null for parse errors

§Examples

use airsprotocols_mcp::protocol::{JsonRpcResponse, JsonRpcMessageTrait, RequestId};
use serde_json::json;

// Success response
let success = JsonRpcResponse::success(
    json!({"result": "operation completed"}),
    RequestId::new_number(1)
);

// Use trait methods for serialization
let json = success.to_json().unwrap();
let parsed = JsonRpcResponse::from_json(&json).unwrap();
assert_eq!(success, parsed);

Fields§

§jsonrpc: String

Protocol version - always “2.0” for JSON-RPC 2.0 compliance

§result: Option<Value>

Result of successful method invocation (mutually exclusive with error)

§error: Option<Value>

Error information for failed method invocation (mutually exclusive with result)

§id: Option<RequestId>

Request identifier from the original request (null for parse errors)

Implementations§

Source§

impl JsonRpcResponse

Source

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

Create a successful JSON-RPC 2.0 response

§Parameters
  • result: The successful result of the method invocation
  • id: Request identifier from the original request
§Examples
use airsprotocols_mcp::protocol::{JsonRpcResponse, RequestId};
use serde_json::json;

let response = JsonRpcResponse::success(
    json!({"status": "ok", "data": [1, 2, 3]}),
    RequestId::new_string("req-456")
);
Source

pub fn error(error: Value, id: Option<RequestId>) -> Self

Create an error JSON-RPC 2.0 response

§Parameters
  • error: Error information (should conform to JSON-RPC error object structure)
  • id: Request identifier from the original request (None for parse errors)
§Examples
use airsprotocols_mcp::protocol::{JsonRpcResponse, RequestId};
use serde_json::json;

let response = JsonRpcResponse::error(
    json!({"code": -32602, "message": "Invalid params"}),
    Some(RequestId::new_number(789))
);
Source

pub fn error_standard( code: i32, message: &str, data: Option<Value>, id: Option<RequestId>, ) -> Self

Create a standardized JSON-RPC 2.0 error response

This function creates a properly formatted JSON-RPC 2.0 error response with the correct error object structure according to the specification.

§Parameters
  • code: JSON-RPC error code (use constants from error_codes module)
  • message: Human-readable error message
  • data: Optional additional error data
  • id: Request identifier from the original request (None for parse errors)
§Examples
use airsprotocols_mcp::protocol::{JsonRpcResponse, RequestId};
use airsprotocols_mcp::protocol::constants::error_codes;

let response = JsonRpcResponse::error_standard(
    error_codes::INVALID_PARAMS,
    "Missing required parameter 'name'",
    Some(serde_json::json!({"parameter": "name"})),
    Some(RequestId::new_number(123))
);
Source

pub fn parse_error(message: &str, data: Option<Value>) -> Self

Create a parse error response (-32700)

Source

pub fn invalid_request( message: &str, data: Option<Value>, id: Option<RequestId>, ) -> Self

Create an invalid request error response (-32600)

Source

pub fn method_not_found(method: &str, id: Option<RequestId>) -> Self

Create a method not found error response (-32601)

Source

pub fn invalid_params( message: &str, data: Option<Value>, id: Option<RequestId>, ) -> Self

Create an invalid params error response (-32602)

Source

pub fn internal_error( message: &str, data: Option<Value>, id: Option<RequestId>, ) -> Self

Create an internal error response (-32603)

Trait Implementations§

Source§

impl Clone for JsonRpcResponse

Source§

fn clone(&self) -> JsonRpcResponse

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 Debug for JsonRpcResponse

Source§

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

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

impl<'de> Deserialize<'de> for JsonRpcResponse

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 JsonRpcMessageTrait for JsonRpcResponse

Source§

fn to_json(&self) -> Result<String, Error>

Serialize this message to JSON string Read more
Source§

fn to_json_pretty(&self) -> Result<String, Error>

Serialize this message to pretty-printed JSON Read more
Source§

fn from_json(json: &str) -> Result<Self, Error>

Deserialize from JSON string Read more
Source§

fn serialize_to_buffer(&self, buffer: &mut BytesMut) -> Result<(), Error>

Zero-copy serialization to buffer Read more
Source§

fn to_bytes(&self) -> Result<Bytes, Error>

Serialize this message to bytes Read more
Source§

fn from_json_bytes(json: &[u8]) -> Result<Self, Error>

Deserialize a message from JSON bytes Read more
Source§

impl PartialEq for JsonRpcResponse

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for JsonRpcResponse

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 StructuralPartialEq for JsonRpcResponse

Auto Trait Implementations§

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> 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>,