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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
//! # jrpc: an ultra lightweight crate for types from the jsonrpc spec //! //! This crate defines the datatypes for the jsonrpc spec... and that is IT. //! //! This crate never touches the network, filesystem, etc. It simply uses serde //! to easily construct, serialize and deserialize Request and Response data types. //! //! # Specification //! //! The below is directly copy/pasted from: [http://www.jsonrpc.org/specification][spec] //! //! The types try to correctly copy the relevant documentation snippets in their docstring. //! //! [spec]: http://www.jsonrpc.org/specification //! //! ## 1 Overview //! //! JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. Primarily this //! specification defines several data structures and the rules around their processing. It is //! transport agnostic in that the concepts can be used within the same process, over sockets, over //! http, or in many various message passing environments. It uses JSON (RFC 4627) as data format. //! //! It is designed to be simple! //! //! # 2 Conventions //! //! The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", //! "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted //! as described in RFC 2119. //! //! Since JSON-RPC utilizes JSON, it has the same type system (see http://www.json.org or RFC //! 4627). JSON can represent four primitive types (Strings, Numbers, Booleans, and Null) and two //! structured types (Objects and Arrays). The term "Primitive" in this specification references //! any of those four primitive JSON types. The term "Structured" references either of the //! structured JSON types. Whenever this document refers to any JSON type, the first letter is //! always capitalized: Object, Array, String, Number, Boolean, Null. True and False are also //! capitalized. //! //! All member names exchanged between the Client and the Server that are considered for matching //! of any kind should be considered to be case-sensitive. The terms function, method, and //! procedure can be assumed to be interchangeable. //! //! The Client is defined as the origin of Request objects and the handler of Response objects. //! //! The Server is defined as the origin of Response objects and the handler of Request objects. //! //! One implementation of this specification could easily fill both of those roles, even at the //! same time, to other different clients or the same client. This specification does not address //! that layer of complexity. //! //! ## 3 Compatibility //! //! JSON-RPC 2.0 Request objects and Response objects may not work with existing JSON-RPC 1.0 //! clients or servers. However, it is easy to distinguish between the two versions as 2.0 always //! has a member named "jsonrpc" with a String value of "2.0" whereas 1.0 does not. Most 2.0 //! implementations should consider trying to handle 1.0 objects, even if not the peer-to-peer and //! class hinting aspects of 1.0. //! //! ## 4 Request Object //! //! See [`Request`](struct.Request.html) //! //! //! ## 4.1 Notification //! //! See [`IdReq`](enum.IdReq.html) //! //! ## 4.2 Parameter Structures //! //! See [`Request.params`](struct.Request.html#structfield.params) //! //! ## 5 Response object //! //! See [`Response`](struct.Response.html) //! //! ## 5.1 Error object //! //! See [`ErrorObject`](struct.ErrorObject.html) //! //! ## 6 Batch //! //! > Note: simply use a `Vec<Request>` and `Vec<Response>` //! //! To send several Request objects at the same time, the Client MAY send an Array filled with //! Request objects. //! //! The Server should respond with an Array containing the corresponding Response objects, after //! all of the batch Request objects have been processed. A Response object SHOULD exist for each //! Request object, except that there SHOULD NOT be any Response objects for notifications. The //! Server MAY process a batch rpc call as a set of concurrent tasks, processing them in any order //! and with any width of parallelism. //! //! The Response objects being returned from a batch call MAY be returned in any order within the //! Array. The Client SHOULD match contexts between the set of Request objects and the resulting //! set of Response objects based on the id member within each Object. //! //! If the batch rpc call itself fails to be recognized as an valid JSON or as an Array with at //! least one value, the response from the Server MUST be a single Response object. If there are no //! Response objects contained within the Response array as it is to be sent to the client, the //! server MUST NOT return an empty Array and should return nothing at all. //! //! ## 7 Examples //! //! Ommitted. See the [specification][spec] //! //! ## 8 Extensions //! //! This library does not support checking for extensions. See //! [`Request.method`](struct.Request.html#structfield.method) for more details of the spec. #![allow(unknown_lints)] #![allow(redundant_field_names)] #![warn(missing_docs)] extern crate serde; #[macro_use] extern crate serde_derive; extern crate serde_json; extern crate std_prelude; pub use serde_json::Value; mod serialize; use std_prelude::*; use serde::ser::Serialize; use serde::de::DeserializeOwned; /// The `jsonrpc` version. Will serialize/deserialize to/from `"2.0"`. pub struct V2_0; /// An identifier established by the Client that MUST contain a String, Number, or NULL value if /// included. If it is not included it is assumed to be a notification. The value SHOULD normally /// not be Null and Numbers SHOULD NOT contain fractional parts /// /// The Server MUST reply with the same value in the Response object if included. This member is /// used to correlate the context between the two objects. /// /// # Examples /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::Id; /// /// # fn main() { /// assert_eq!(Id::from(4), Id::Int(4)); /// assert_eq!( /// serde_json::from_str::<Id>("4").unwrap(), /// Id::Int(4), /// ); /// assert_eq!( /// serde_json::from_str::<Id>("\"foo\"").unwrap(), /// Id::String("foo".into()), /// ); /// assert_eq!( /// serde_json::from_str::<Id>("null").unwrap(), /// Id::Null, /// ); /// # } /// ``` #[derive(Debug, Clone, Eq, PartialEq, Hash, Serialize, Deserialize)] #[serde(untagged)] pub enum Id { /// An String id String(String), /// An Number id that must be an integer. /// /// We intentionally do not allow floating point values. Int(i64), /// A null id Null, } impl From<String> for Id { fn from(s: String) -> Self { Id::String(s) } } impl<'a> From<&'a str> for Id { fn from(s: &'a str) -> Self { Id::String(s.into()) } } impl From<i64> for Id { fn from(v: i64) -> Self { Id::Int(v) } } /// Identical to [`Id`](enum.Id.html) except has the Notification type. Typically you should use /// `Id` since all functions that would accept IdReq accept `Into<IdReq>`. /// /// # Notification /// /// A Notification is a Request object without an "id" member. A Request object that is a /// Notification signifies the Client's lack of interest in the corresponding Response object, and /// as such no Response object needs to be returned to the client. The Server MUST NOT reply to a /// Notification, including those that are within a batch request. /// /// Notifications are not confirmable by definition, since they do not have a Response object to be /// returned. As such, the Client would not be aware of any errors (like e.g. "Invalid /// params","Internal error"). /// /// https://github.com/serde-rs/serde/issues/984 /// /// # Examples /// This just demonstrates what happens if `id` is absent vs null. /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, IdReq, Request, Value}; /// /// # fn main() { /// // id == null /// let json = r#" /// { /// "jsonrpc": "2.0", /// "method": "CreateFoo", /// "id": null /// } /// "#; /// let request: Request<String, Value> = serde_json::from_str(json).unwrap(); /// assert_eq!(request.id, Id::Null.into()); /// /// // id does not exist /// let json = r#" /// { /// "jsonrpc": "2.0", /// "method": "NotifyFoo" /// } /// "#; /// let request: Request<String, Value> = serde_json::from_str(json).unwrap(); /// assert_eq!(request.id, IdReq::Notification); /// # } /// ``` #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] #[serde(untagged)] pub enum IdReq { /// An String id String(String), /// An Number id that must be an integer. /// /// We intentionally do not allow floating point values. Int(i64), /// A null id Null, /// The notification id, i.e. the id is absent. Notification, } impl From<Id> for IdReq { fn from(id: Id) -> Self { match id { Id::String(s) => IdReq::String(s), Id::Int(i) => IdReq::Int(i), Id::Null => IdReq::Null, } } } impl IdReq { /// Attempt to convert to an Id. /// /// Returns `None` if this Id is a `Notification`. pub fn to_id(self) -> Option<Id> { let out = match self { IdReq::String(s) => Id::String(s), IdReq::Int(i) => Id::Int(i), IdReq::Null => Id::Null, IdReq::Notification => return None, }; Some(out) } } /// A rpc call is represented by sending a Request object to a Server. /// /// See the parameters for details. /// /// # Examples /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Request, V2_0}; /// /// # fn main() { /// let value: Vec<u32> = vec![1, 2, 3]; /// let request = Request::with_params( /// Id::from(4), /// "CreateFoo".to_string(), /// Some(value.clone()), /// ); /// let json = r#" /// { /// "jsonrpc": "2.0", /// "method": "CreateFoo", /// "params": [1,2,3], /// "id": 4 /// } /// "#; /// let json = json.replace("\n", "").replace(" ", ""); /// let result = serde_json::to_string(&request).unwrap(); /// assert_eq!(json, result); /// # } /// ``` #[derive(Debug, Serialize, Deserialize)] pub struct Request<M, T> { /// A String specifying the version of the JSON-RPC protocol. MUST be exactly "2.0". pub jsonrpc: V2_0, /// A serializable method. /// /// The spec states it must be a String containing the name of the method to be invoked. This /// library makes no guarantees about this. It is recomended to use a simple `enum` for your /// library's `method`. /// /// ## Section 8: Extensions /// /// Method names that begin with `"rpc."` are reserved for system extensions, and MUST NOT be /// used for anything else. Each system extension is defined in a related specification. All /// system extensions are OPTIONAL. /// /// This library provides no way of checking for system extensions. pub method: M, /// A Structured value that holds the parameter values to be used during the invocation of the /// method. /// /// ## Spec Requiement /// /// > Note: the following spec is **not** upheld by this library. /// /// If present, parameters for the rpc call MUST be provided as a Structured value. Either /// by-position through an Array or by-name through an Object. /// /// - by-position: params MUST be an Array, containing the values in the Server expected /// order. /// - by-name: params MUST be an Object, with member names that match the Server expected /// parameter names. The absence of expected names MAY result in an error being /// generated. The names MUST match exactly, including case, to the method's expected /// parameters. /// #[serde(default)] pub params: Option<T>, /// The `id`. See [`Id`](enum.Id.html) #[serde(default = "notification")] pub id: IdReq, } impl<M: Serialize + DeserializeOwned, T: Serialize + DeserializeOwned> Request<M, T> { /// Helper to serialize the Request as json. pub fn to_string(&self) -> String { serde_json::to_string(self).unwrap() } /// Helper to deserialize the Request from json. pub fn from_str(s: &str) -> serde_json::Result<T> { serde_json::from_str(s) } } impl<M: Serialize + DeserializeOwned> Request<M, ()> { /// Create a new Request. /// /// # Examples /// /// # extern crate jrpc; /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Request}; /// /// # fn main() { /// let value: Vec<u32> = vec![1, 2, 3]; /// let request = Request::new( /// Id::from(4), /// "CreateFoo".to_string(), /// ); /// println!("{}", request.to_string()); /// # } pub fn new<I>(id: I, method: M) -> Self where I: Into<IdReq>, { let params: Option<()> = None; Self { jsonrpc: V2_0, method: method, params: params, id: id.into(), } } } impl<M: Serialize + DeserializeOwned, T: Serialize + DeserializeOwned> Request<M, T> { /// Create a new Request with the specified params. pub fn with_params<I>(id: I, method: M, params: T) -> Self where I: Into<IdReq>, { Self { jsonrpc: V2_0, method: method, params: Some(params), id: id.into(), } } } /// Parse a json string, returning either: /// - The parsed `Request` /// - An `Error` object created according to the jsonrpc spec (with a _useful_ reason/message). /// /// This parses the json in stages and will correctly return one of the following errors on /// failure: /// /// - `ParseError` /// - `InvalidRequest` /// - `MethodNotFound` /// /// > Reminder: It is up to the user to return the `InvalidParams` error if the `request.params` is /// > invalid. /// /// # Examples /// /// ## Well formed Request /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Request, V2_0}; /// /// # fn main() { /// let params: Vec<u32> = vec![1, 2, 3]; /// let request = Request::with_params( /// Id::from(4), /// "CreateFoo".to_string(), /// Some(params.clone()), /// ); /// let json = r#" /// { /// "jsonrpc": "2.0", /// "method": "CreateFoo", /// "params": [1,2,3], /// "id": 4 /// } /// "#; /// /// let result: Request<String, _> = jrpc::parse_request(json).unwrap(); /// let result_params: Vec<u32> = serde_json::from_value( /// result.params.unwrap()).unwrap(); /// assert_eq!(params, result_params); /// assert_eq!(request.method, result.method); /// assert_eq!(request.id, result.id); /// # } /// ``` /// /// ## Error: `ParseError` /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Request, V2_0}; /// /// # fn main() { /// let params: Vec<u32> = vec![1, 2, 3]; /// let json = r#" /// Not Valid JSON... /// "#; /// /// let result: Result<jrpc::Request<String, jrpc::Value>, jrpc::Error<jrpc::Value>> = /// jrpc::parse_request(json); /// /// let error = result.unwrap_err(); /// assert_eq!(error.error.code, jrpc::ErrorCode::ParseError); /// # } /// ``` /// /// ## Error: `InvalidRequest` /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Request, V2_0}; /// /// # fn main() { /// let params: Vec<u32> = vec![1, 2, 3]; /// let json = r#" /// { /// "type": "valid json", /// "but": "not jsonrpc!" /// } /// "#; /// /// let result: Result<jrpc::Request<String, jrpc::Value>, jrpc::Error<jrpc::Value>> = /// jrpc::parse_request(json); /// /// let error = result.unwrap_err(); /// assert_eq!(error.error.code, jrpc::ErrorCode::InvalidRequest); /// assert!(error.error.message.contains("missing field `jsonrpc`")); /// assert_eq!(error.id, jrpc::Id::Null); /// # } /// ``` /// /// ## Error: `MethodNotFound` /// /// ```rust /// # extern crate jrpc; /// #[macro_use] extern crate serde_derive; /// extern crate serde_json; /// use jrpc::{Id, Request, V2_0}; /// /// #[derive(Debug, Serialize, Deserialize)] /// enum Method { /// One, /// Two, /// } /// /// # fn main() { /// let params: Vec<u32> = vec![1, 2, 3]; /// let json = r#" /// { /// "jsonrpc": "2.0", /// "method": "Three", /// "params": [1,2,3], /// "id": 4 /// } /// "#; /// /// let result: Result<jrpc::Request<Method, jrpc::Value>, jrpc::Error<jrpc::Value>> = /// jrpc::parse_request(json); /// /// let error = result.unwrap_err(); /// assert_eq!(error.error.code, jrpc::ErrorCode::MethodNotFound); /// assert!(error.error.message.contains( /// "unknown variant `Three`, expected `One` or `Two`")); /// assert_eq!(error.id, jrpc::Id::Int(4)); /// # } /// ``` pub fn parse_request<M>(json: &str) -> Result<Request<M, Value>, Error<Value>> where M: Serialize + DeserializeOwned, { let value: serde_json::Value = serde_json::from_str(json) .map_err(|err| Error::new(Id::Null, ErrorCode::ParseError, err.to_string(), None))?; let request: Request<Value, Value> = serde_json::from_value(value) .map_err(|err| Error::new(Id::Null, ErrorCode::InvalidRequest, err.to_string(), None))?; let (id, method, params) = (request.id, request.method, request.params); let method: M = serde_json::from_value(method).map_err(|err| { Error::new( id.clone().to_id().unwrap_or(Id::Null), ErrorCode::MethodNotFound, err.to_string(), None, ) })?; Ok(Request { jsonrpc: V2_0, method: method, params: params, id: id, }) } /// The Result is either: /// - a jsonrpc Response (with a result of a specific type) /// - a Error (with an error of type `serde_json::Value`). /// /// # Example /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Response}; /// /// # fn main() { /// let data: Vec<u32> = vec![1, 2, 3]; /// let example = Response::success(Id::from(4), data.clone()); /// let json = r#" /// { /// "jsonrpc": "2.0", /// "result": [1,2,3], /// "id": 4 /// } /// "#; /// let json = json.replace("\n", "").replace(" ", ""); /// let result = serde_json::to_string(&example).unwrap(); /// assert_eq!(json, result); /// # } /// ``` #[derive(Debug, Serialize, Deserialize)] #[serde(untagged)] pub enum Response<T> { /// The Response has a `result` object and not an `error` object. Ok(Success<T>), /// The Response has a `error` object and not an `result` object. Err(Error<Value>), } impl<T: Serialize + DeserializeOwned> Response<T> { /// Retrieve the `id` regardless of whether there was an error or not. pub fn id(&self) -> &Id { match *self { Response::Ok(ref r) => &r.id, Response::Err(ref e) => &e.id, } } /// Construct a `Success` pub fn success(id: Id, result: T) -> Self { Response::Ok(Success::new(id, result)) } /// Construct an `Error` pub fn error<C, S>(id: Id, code: C, message: S, data: Option<Value>) -> Self where C: Into<ErrorCode>, S: Into<String>, { Response::Err(Error::new(id, code, message, data)) } /// Helper to serialize the Response as json. pub fn to_string(&self) -> String { serde_json::to_string(self).unwrap() } /// Helper to deserialize the Response from json. pub fn from_str(s: &str) -> serde_json::Result<T> { serde_json::from_str(s) } } /// The jsonrpc Success response, indicating a successful result. /// /// See the parameters for more information. /// /// # Examples /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Success}; /// /// # fn main() { /// let data: Vec<u32> = vec![1, 2, 3]; /// let example = Success::new(Id::from(4), data.clone()); /// let json = r#" /// { /// "jsonrpc": "2.0", /// "result": [1,2,3], /// "id": 4 /// } /// "#; /// let json = json.replace("\n", "").replace(" ", ""); /// let result = serde_json::to_string(&example).unwrap(); /// assert_eq!(json, result); /// # } /// ``` #[derive(Debug, Serialize, Deserialize)] #[serde(deny_unknown_fields)] pub struct Success<T> { /// A String specifying the version of the JSON-RPC protocol. MUST be exactly "2.0". pub jsonrpc: V2_0, /// The value of this member is determined by the method invoked on the Server. pub result: T, /// This member is REQUIRED. /// /// It MUST be the same as the value of the id member in the Request Object. /// /// If there was an error in detecting the id in the Request object (e.g. Parse error/Invalid /// Request), it MUST be Null. pub id: Id, } impl<T: Serialize + DeserializeOwned> Success<T> { /// Construct a `Success`, i.e. a Response with a `result` object. pub fn new(id: Id, result: T) -> Self { Self { jsonrpc: V2_0, result: result, id: id, } } /// Helper to serialize the Success as json. pub fn to_string(&self) -> String { serde_json::to_string(self).unwrap() } /// Helper to deserialize the Success from json. pub fn from_str(s: &str) -> serde_json::Result<T> { serde_json::from_str(s) } } /// The jsonrpc Error response, indicating an error. /// /// # Examples /// /// Since the `T` in the `ErrorObject` will _at least_ be based on the `ErrorCode` it is /// recommended that you deserialize this type as `T=Value` first. /// /// ```rust /// # extern crate jrpc; /// extern crate serde_json; /// use jrpc::{Id, Error, ErrorCode, ErrorObject, V2_0}; /// /// # fn main() { /// let data: Vec<u32> = vec![1, 2, 3]; /// let example = Error { /// jsonrpc: V2_0, /// error: ErrorObject { /// code: ErrorCode::from(-32000), /// message: "BadIndexes".into(), /// data: Some(data.clone()), /// }, /// id: Id::from(4), /// }; /// /// let json = r#" /// { /// "jsonrpc": "2.0", /// "error": { /// "code": -32000, /// "message": "BadIndexes", /// "data": [1,2,3] /// }, /// "id": 4 /// } /// "#; /// let json = json.replace("\n", "").replace(" ", ""); /// let result = serde_json::to_string(&example).unwrap(); /// assert_eq!(json, result); /// /// // This is how it is recommended you deserialize: /// let error: Error<serde_json::Value> = /// serde_json::from_str(&json).unwrap(); /// if error.error.code != ErrorCode::ServerError(-32000) { /// panic!("unexpected error"); /// } /// let result: Vec<u32> = serde_json::from_value( /// error.error.data.unwrap() /// ).unwrap(); /// assert_eq!(data, result); /// # } /// ``` #[derive(Debug, Serialize, Deserialize)] #[serde(deny_unknown_fields)] pub struct Error<T> { /// Always "2.0" pub jsonrpc: V2_0, /// The error object. pub error: ErrorObject<T>, /// The id of the request. pub id: Id, } impl<T: Serialize + DeserializeOwned> Error<T> { /// Helper to create a new `Error` object. pub fn new<C, S>(id: Id, code: C, message: S, data: Option<T>) -> Self where C: Into<ErrorCode>, S: Into<String>, { Error { jsonrpc: V2_0, error: ErrorObject { code: code.into(), message: message.into(), data: data, }, id: id, } } /// Helper to serialize the Error as json. pub fn to_string(&self) -> String { serde_json::to_string(self).unwrap() } /// Helper to deserialize the Error from json. pub fn from_str(s: &str) -> serde_json::Result<T> { serde_json::from_str(s) } } /// The jsonrpc Error object, with details of the error. /// /// When a rpc call encounters an error, the Response Object MUST contain the error member with a /// value that is a Object. See the attributes for details. #[derive(Debug, Serialize, Deserialize)] pub struct ErrorObject<T> { /// The error code. See [`ErrorCode`](enum.ErrorCode.html) pub code: ErrorCode, /// A String providing a short description of the error. /// /// The message SHOULD be limited to a concise single sentence. pub message: String, /// A Primitive or Structured value that contains additional information about the error. /// /// This may be omitted. /// /// The value of this member is defined by the Server (e.g. detailed error /// information, nested errors etc.). #[serde(default = "default_t")] pub data: Option<T>, } /// A Number that indicates the error type that occurred. /// This MUST be an integer. /// /// The error codes from and including -32768 to -32000 are reserved for pre-defined errors. /// Any code within this range, but not defined explicitly below is reserved for future use. /// The error codes are nearly the same as those suggested for XML-RPC at the following url: /// http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php /// /// Use the [`is_valid()`](enum.ErrorCode.html#method.is_valid) method to determine compliance. #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)] pub enum ErrorCode { /// - `-32700`: Parse error. Invalid JSON was received by the server. /// An error occurred on the server while parsing the JSON text. ParseError, /// - `-32600`: Invalid Request. The JSON sent is not a valid Request object. InvalidRequest, /// - `-32601`: Method not found. The method does not exist / is not available. MethodNotFound, /// - `-32602`: Invalid params. Invalid method parameter(s). InvalidParams, /// - `-32603`: Internal error. Internal JSON-RPC error. InternalError, /// - `-32000 to -32099`: Server error. Reserved for implementation-defined server-errors. ServerError(i64), } impl ErrorCode { /// Return whether the ErrorCode is correct. /// /// This will only return `false` if this is `ServerError` and is outside of the range of -32000 /// to -32099. pub fn is_valid(&self) -> bool { match *self { ErrorCode::ServerError(value) => (-32099 <= value) && (value <= -32000), _ => true, } } } impl From<i64> for ErrorCode { fn from(v: i64) -> ErrorCode { match v { -32700 => ErrorCode::ParseError, -32600 => ErrorCode::InvalidRequest, -32601 => ErrorCode::MethodNotFound, -32602 => ErrorCode::InvalidParams, -32603 => ErrorCode::InternalError, _ => ErrorCode::ServerError(v), } } } fn notification() -> IdReq { IdReq::Notification } fn default_t<T>() -> Option<T> { None }