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

//! JSON-RPC response types
use serde::{Deserialize, Serialize};
use serde_json::Value;
use crate::error::Error;
use crate::request::Id;

/// JSON-RPC response object
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Response {
    /// 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>,
    
    /// Result of the method invocation (on success)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub result: Option<Value>,
    
    /// Error object (on failure)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<Error>,
    
    /// Request identifier
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<Id>,
}

impl Response {

    /// Alias for the current version: Create a new JSON-RPC 2.0 success response
    pub fn success(result: Value, id: Option<Id>) -> Self {
        Response::success_v2(result, id)
    }
    
    /// Alias for the current version: Create a new JSON-RPC 2.0 error response
    pub fn error(error: Error, id: Option<Id>) -> Self {
        Response::error_v2(error, id)
    }

    /// Create a new JSON-RPC 2.0 success response
    pub fn success_v2(result: Value, id: Option<Id>) -> Self {
        Response {
            jsonrpc: Some("2.0".to_string()),
            version: None,
            result: Some(result),
            error: None,
            id,
        }
    }
    
    /// Create a new JSON-RPC 2.0 error response
    pub fn error_v2(error: Error, id: Option<Id>) -> Self {
        Response {
            jsonrpc: Some("2.0".to_string()),
            version: None,
            result: None,
            error: Some(error),
            id,
        }
    }
    
    /// Create a new JSON-RPC 1.1 success response
    pub fn success_v1_1(result: Value, id: Option<Id>) -> Self {
        Response {
            jsonrpc: None,
            version: Some("1.1".to_string()),
            result: Some(result),
            error: None,
            id,
        }
    }
    
    /// Create a new JSON-RPC 1.1 error response
    pub fn error_v1_1(error: Error, id: Option<Id>) -> Self {
        Response {
            jsonrpc: None,
            version: Some("1.1".to_string()),
            result: None,
            error: Some(error),
            id,
        }
    }
    
    /// Create a new JSON-RPC 1.0 success response
    pub fn success_v1(result: Value, id: Option<Id>) -> Self {
        Response {
            jsonrpc: None,
            version: None,
            result: Some(result),
            error: None,
            id,
        }
    }
    
    /// Create a new JSON-RPC 1.0 error response
    pub fn error_v1(error: Error, id: Option<Id>) -> Self {
        Response {
            jsonrpc: None,
            version: None,
            result: None,
            error: Some(error),
            id,
        }
    }
    
    /// Check if this is a success response
    pub fn is_success(&self) -> bool {
        self.error.is_none()
    }
    
    /// Check if this is an error response
    pub fn is_error(&self) -> bool {
        self.error.is_some()
    }
}