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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
//! A set of types for representing JSON-RPC requests and responses as defined in //! the [specification](https://www.jsonrpc.org/specification). //! //! # Usage //! //! ## Creates JSON-RPC v1 request //! //! ```rust //! # use jsonrpc_types::{Call, Id, MethodCall, Notification, Params, Request}; //! // Creates a JSON-RPC v1 notification request //! let notification = Notification { //! jsonrpc: None, //! method: "foo".into(), //! params: Some(Params::Array(vec![])), //! }; //! let notification_req = Request::Single(Call::Notification(notification.clone())); //! assert_eq!( //! serde_json::to_string(¬ification_req).unwrap(), //! r#"{"method":"foo","params":[],"id":null}"# //! ); //! //! // Creates a JSON-RPC v1 method call request //! let method_call = MethodCall { //! jsonrpc: None, //! method: "foo".into(), //! params: Some(Params::Array(vec![])), //! id: Id::Num(1), //! }; //! let method_call_req = Request::Single(Call::MethodCall(method_call)); //! assert_eq!( //! serde_json::to_string(&method_call_req).unwrap(), //! r#"{"method":"foo","params":[],"id":1}"# //! ); //! //! // Creates a JSON-RPC v1 batch request //! let batch_request = Request::Batch(vec![ //! Call::MethodCall(MethodCall { //! jsonrpc: None, //! method: "foo".into(), //! params: Some(Params::Array(vec![])), //! id: Id::Num(1), //! }), //! Call::MethodCall(MethodCall { //! jsonrpc: None, //! method: "bar".into(), //! params: Some(Params::Array(vec![])), //! id: Id::Num(2), //! }), //! ]); //! assert_eq!( //! serde_json::to_string(&batch_request).unwrap(), //! r#"[{"method":"foo","params":[],"id":1},{"method":"bar","params":[],"id":2}]"# //! ); //! ``` //! //! ## Creates JSON-RPC v2 request //! //! ```rust //! # use jsonrpc_types::{Id, Version, Params, MethodCall, Notification, Call, Request}; //! // Creates a JSON-RPC v2 notification request //! let notification = Notification { //! jsonrpc: Some(Version::V2_0), //! method: "foo".into(), //! params: Some(Params::Array(vec![])), //! }; //! let notification_req = Request::Single(Call::Notification(notification.clone())); //! assert_eq!( //! serde_json::to_string(¬ification_req).unwrap(), //! r#"{"jsonrpc":"2.0","method":"foo","params":[]}"# //! ); //! //! // Creates a JSON-RPC v2 method call request //! let method_call = MethodCall { //! jsonrpc: Some(Version::V2_0), //! method: "foo".into(), //! params: Some(Params::Array(vec![])), //! id: Id::Num(1), //! }; //! let method_call_req = Request::Single(Call::MethodCall(method_call)); //! assert_eq!( //! serde_json::to_string(&method_call_req).unwrap(), //! r#"{"jsonrpc":"2.0","method":"foo","params":[],"id":1}"# //! ); //! //! // Creates a JSON-RPC v2 batch request //! let batch_request = Request::Batch(vec![ //! Call::MethodCall(MethodCall { //! jsonrpc: Some(Version::V2_0), //! method: "foo".into(), //! params: Some(Params::Array(vec![])), //! id: Id::Num(1), //! }), //! Call::MethodCall(MethodCall { //! jsonrpc: Some(Version::V2_0), //! method: "bar".into(), //! params: Some(Params::Array(vec![])), //! id: Id::Num(2), //! }), //! ]); //! assert_eq!( //! serde_json::to_string(&batch_request).unwrap(), //! r#"[{"jsonrpc":"2.0","method":"foo","params":[],"id":1},{"jsonrpc":"2.0","method":"bar","params":[],"id":2}]"# //! ); //! ``` //! //! ## Creates JSON-RPC v1 response //! //! ```rust //! # use jsonrpc_types::{Id, Value, Error, Response, ResponseOutput, SuccessResponse, FailureResponse}; //! // Creates a JSON-RPC v1 success response //! let success_response = SuccessResponse { //! jsonrpc: None, //! result: Value::Bool(true), //! id: Id::Num(1), //! }; //! let response1 = Response::Single(ResponseOutput::Success(success_response.clone())); //! assert_eq!( //! serde_json::to_string(&response1).unwrap(), //! r#"{"result":true,"error":null,"id":1}"# //! ); //! //! // Creates a JSON-RPC v1 failure response //! let failure_response = FailureResponse { //! jsonrpc: None, //! error: Error::invalid_request(), //! id: Id::Num(2), //! }; //! let response2 = Response::Single(ResponseOutput::Failure(failure_response.clone())); //! assert_eq!( //! serde_json::to_string(&response2).unwrap(), //! r#"{"error":{"code":-32600,"message":"Invalid request"},"result":null,"id":2}"# //! ); //! //! // Creates a JSON-RPC v1 batch response //! let batch_response = Response::Batch(vec![ //! ResponseOutput::Success(success_response), //! ResponseOutput::Failure(failure_response) //! ]); //! assert_eq!( //! serde_json::to_string(&batch_response).unwrap(), //! r#"[{"result":true,"error":null,"id":1},{"error":{"code":-32600,"message":"Invalid request"},"result":null,"id":2}]"# //! ); //! ``` //! //! ## Creates JSON-RPC v2 response //! //! ```rust //! # use jsonrpc_types::{Id, Version, Value, Error, Response, ResponseOutput, SuccessResponse, FailureResponse}; //! // Creates a JSON-RPC v2 success response //! let success_response = SuccessResponse { //! jsonrpc: Some(Version::V2_0), //! result: Value::Bool(true), //! id: Id::Num(1), //! }; //! let response1 = Response::Single(ResponseOutput::Success(success_response.clone())); //! assert_eq!( //! serde_json::to_string(&response1).unwrap(), //! r#"{"jsonrpc":"2.0","result":true,"id":1}"# //! ); //! //! // Creates a JSON-RPC v2 failure response //! let failure_response = FailureResponse { //! jsonrpc: Some(Version::V2_0), //! error: Error::invalid_request(), //! id: Id::Num(2), //! }; //! let response2 = Response::Single(ResponseOutput::Failure(failure_response.clone())); //! assert_eq!( //! serde_json::to_string(&response2).unwrap(), //! r#"{"jsonrpc":"2.0","error":{"code":-32600,"message":"Invalid request"},"id":2}"# //! ); //! //! // Creates a JSON-RPC v2 batch response //! let batch_response = Response::Batch(vec![ //! ResponseOutput::Success(success_response), //! ResponseOutput::Failure(failure_response) //! ]); //! assert_eq!( //! serde_json::to_string(&batch_response).unwrap(), //! r#"[{"jsonrpc":"2.0","result":true,"id":1},{"jsonrpc":"2.0","error":{"code":-32600,"message":"Invalid request"},"id":2}]"# //! ); //! ``` //! #![deny(unused_imports)] #![deny(missing_docs)] // Re-exports pub use serde_json::Value; mod id; mod request; mod response; mod version; pub use self::{ id::Id, request::{Call, MethodCall, Notification, Params, Request}, response::{Error, ErrorCode, FailureResponse, Response, ResponseOutput, SuccessResponse}, version::Version, };