Crate jrpc_types

This crate implements the structures as defined in the JSON-RPC 2.0 Specification

Requirements

These requirements derived from the specification itself.

• The “jsonrpc” field MUST be present in requests, responses, and notifications. Futhormore, the value of the “jsonrpc” field MUST be “2.0”.
• The “id” field MUST contain a String, Number, or Null value in any request or response.
  • The Null value for “id” in a request object is discouraged, as it’s used for responses in which the original request id is unknown.
  • The Number value for “id” SHOULD NOT contain fractional parts, as many decimal fractions cannot be represented exactly as binary fraction.
• The “method” field MUST contain a String in any request.
• The optional “params” field MUST be either an Object (by-name) or Array (by-position) IF the “params” are present in the request or notification.

Dependencies

• serde: used for (de)serialization
• serde_json: used for JSON de(serialization) implementation
• thiserror: used for error reporting

Usage

Requests

You can easily build a JSON-RPC request:

use jrpc_types::JsonRpcRequest;

let data = vec![10, 293, 2, 193, 2];
let req = JsonRpcRequest::builder()
    .method("sort")
    .params_serialize(data)
    .unwrap() // Serialization of parameters could fail, so you need to catch this.
    .id(2)
    .build();

Deserializing a request from a string is super easy:

use jrpc_types::JsonRpcRequest;

let data = r#"{"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 1}"#;
match TryInto::<JsonRpcRequest>::try_into(data) {
    Ok(req) => {
        // .. do something ..
    }
    Err(e) => {
        // .. handle error ..
    }
}

Notifications

JSON-RPC Notifications are pretty much Requests, without an ID… You can build Notifications like:

use jrpc_types::JsonRpcNotification;

let data = vec![10, 293, 2, 193, 2];
let req = JsonRpcNotification::builder()
    .method("event")
    .params_serialize(data)
    .unwrap() // Serialization of parameters could fail, so you need to catch this.
    .build();

Deserializing a notification from a string is super easy:

use jrpc_types::JsonRpcNotification;

let data = r#"{"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]}"#;
match TryInto::<JsonRpcNotification>::try_into(data) {
    Ok(req) => {
        // .. do something ..
    }
    Err(e) => {
        // .. handle error ..
    }
}

Response

A JSON-RPC response contains different fields depending on success or error. There is also a select set of (code, message) pairs for errors that are defined in the spec. The builder implementation makes it incredibly easy to build these responses.

Success response (w/ optional data):

use jrpc_types::JsonRpcResponse;

let data = vec![10, 293, 2, 193, 2];
let req = JsonRpcResponse::builder()
    .success()
    .result_serialize(data)
    .unwrap() // Serialization of parameters could fail, so you need to catch this.
    .id(2)
    .build();

Invalid request error:

use jrpc_types::JsonRpcResponse;

let data = vec![10, 293, 2, 193, 2];
let req = JsonRpcResponse::builder()
    .error()
    .invalid_request()
    .id(2)
    .build();

Custom Error:

use jrpc_types::JsonRpcResponse;

let data = vec![10, 293, 2, 193, 2];
let req = JsonRpcResponse::builder()
    .error()
    .code(-23)
    .message("bad request man...")
    .id(2)
    .build();

NOTE: If you are processing a JsonRpcRequest and building a JsonRpcResponse, you can use &JsonRpcRequest in the id() builder function.

use jrpc_types::{JsonRpcRequest, JsonRpcResponse};

// Just for docs, creating this here.. assume you have this.
let req = JsonRpcRequest::builder()
    .id(10)
    .method("subtract")
    .params_str("[5,2]")
    .unwrap() // Serialization of parameters could fail, so you need to catch this.
    .build();

// ... process stuff ...

let rsp = JsonRpcResponse::builder()
    .id(&req)
    .success()
    .result_serialize(3)
    .unwrap() // Serialization of parameters could fail, so you need to catch this.
    .build();

Re-exports

pub use error::Error as JsonRpcError;

pub use notification::Notification as JsonRpcNotification;

pub use request::Request as JsonRpcRequest;

pub use response::Response as JsonRpcResponse;

Modules

error

This module implements the error object for jrpc-types crate.

id

This module implements the structure for the “id” field in JSON-RPC objects.

notification

This module implements the notification JSON-RPC object.

params

This module implements the structure for the “params” field in JSON-RPC objects.

request

This module implements the request JSON-RPC object.

response

This module implements the response JSON-RPC object.

version

This module implements the validation logic for JSON-RPC “jsonrpc” field.