jsonrpcmsg 0.1.2

A Rust library to serialize (encode) and deserialize (parse) JSON-RPC messages.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! JSON-RPC request types
use serde::{Deserialize, Serialize};
use serde_json::{Value, Map};
use crate::version::Version;

/// Parameter types for JSON-RPC requests
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Params {
    /// Positional parameters as an array
    Array(Vec<Value>),
    /// Named parameters as an object
    Object(Map<String, Value>),
}

/// Identifier types for JSON-RPC requests
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Id {
    /// String identifier
    String(String),
    /// Numeric identifier
    Number(u64),
    /// Null identifier (for notifications)
    Null,
}

/// JSON-RPC request object
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Request {
    /// JSON-RPC version (2.0)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub jsonrpc: Option<String>,
    
    /// JSON-RPC version (1.1)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    
    /// Name of the method to be invoked
    pub method: String,
    
    /// Parameters for the method invocation
    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<Params>,
    
    /// Request identifier
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<Id>,
}

impl Request {

    /// Alias for current version: Create a new JSON-RPC 2.0 request
    pub fn new(method: String, params: Option<Params>, id: Option<Id>) -> Self {
        Request::new_v2(method, params, id)
    }

    /// Create a new JSON-RPC 2.0 request
    pub fn new_v2(method: String, params: Option<Params>, id: Option<Id>) -> Self {
        Request {
            jsonrpc: Some("2.0".to_string()),
            version: None,
            method,
            params,
            id,
        }
    }
    
    /// Create a new JSON-RPC 1.1 request
    pub fn new_v1_1(method: String, params: Option<Params>, id: Option<Id>) -> Self {
        Request {
            jsonrpc: None,
            version: Some("1.1".to_string()),
            method,
            params,
            id,
        }
    }
    
    /// Create a new JSON-RPC 1.0 request
    pub fn new_v1(method: String, params: Option<Params>, id: Option<Id>) -> Self {
        Request {
            jsonrpc: None,
            version: None,
            method,
            params,
            id,
        }
    }

    /// Alias for current version: Create a notification (request without id) 
    pub fn notification(method: String, params: Option<Params>) -> Self {
        Request::notification_v2(method, params)
    }

    /// Create a notification (request without id)
    pub fn notification_v2(method: String, params: Option<Params>) -> Self {
        Request {
            jsonrpc: Some("2.0".to_string()),
            version: None,
            method,
            params,
            id: None,
        }
    }

    /// Check if this is a notification (no id field)
    pub fn is_notification(&self) -> bool {
        self.id.is_none()
    }
    
    /// Get the version of this request
    pub fn version(&self) -> Option<Version> {
        if self.jsonrpc.is_some() {
            Version::from_str(self.jsonrpc.as_ref().unwrap())
        } else if self.version.is_some() {
            Version::from_str(self.version.as_ref().unwrap())
        } else {
            Some(Version::V1_0)
        }
    }
}