Struct JsonRpcRequest 

pub struct JsonRpcRequest {
    pub jsonrpc: String,
    pub method: String,
    pub params: Option<Value>,
    pub id: Option<Value>,
}

JSON-RPC 2.0 Request

Represents a JSON-RPC request method invocation with optional parameters and identifier.

Fields

• jsonrpc - A String specifying the JSON-RPC version. MUST be exactly “2.0”
• method - A String containing the name of the method to be invoked
• params - Optional structured data that serves as arguments to the method. The order of the objects in the Array is significant to the method.
• id - A value which is used to match the response with the request that it is replying to. Can be a string, number, or NULL. Notifications MUST NOT include an “id”.

Example

use serde_json::json;
use spikard_http::jsonrpc::JsonRpcRequest;

// Request with parameters and ID
let req = JsonRpcRequest::new("add", Some(json!([1, 2])), Some(json!(1)));
assert!(!req.is_notification());

// Notification (no ID)
let notif = JsonRpcRequest::new("notify", Some(json!({})), None);
assert!(notif.is_notification());

Fields

jsonrpc: String

JSON-RPC version, must be “2.0”

method: String

The name of the method to invoke

params: Option<Value>

Optional parameters for the method

id: Option<Value>

Optional request identifier. When absent, this is a notification.

Implementations

impl JsonRpcRequest

pub fn new( method: impl Into<String>, params: Option<Value>, id: Option<Value>, ) -> Self

Creates a new JSON-RPC 2.0 request

Arguments

• method - The method name to invoke
• params - Optional parameters (can be array, object, or null)
• id - Optional request identifier (string, number, or null)

Example

use serde_json::json;
use spikard_http::jsonrpc::JsonRpcRequest;

let req = JsonRpcRequest::new("subtract", Some(json!({"a": 5, "b": 3})), Some(json!(2)));
assert_eq!(req.method, "subtract");
assert!(!req.is_notification());

pub fn is_notification(&self) -> bool

Checks if this request is a notification

A notification is a JSON-RPC request without an “id” field. The server MUST NOT reply to a notification.

Example

use spikard_http::jsonrpc::JsonRpcRequest;

let req = JsonRpcRequest::new("method", None, Some(serde_json::json!(1)));
assert!(!req.is_notification());

let notif = JsonRpcRequest::new("notify", None, None);
assert!(notif.is_notification());

Trait Implementations

impl Clone for JsonRpcRequest

fn clone(&self) -> JsonRpcRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonRpcRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsonRpcRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JsonRpcRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.