jsonrpsee_core/
lib.rs

1// Copyright 2019-2021 Parity Technologies (UK) Ltd.
2//
3// Permission is hereby granted, free of charge, to any
4// person obtaining a copy of this software and associated
5// documentation files (the "Software"), to deal in the
6// Software without restriction, including without
7// limitation the rights to use, copy, modify, merge,
8// publish, distribute, sublicense, and/or sell copies of
9// the Software, and to permit persons to whom the Software
10// is furnished to do so, subject to the following
11// conditions:
12//
13// The above copyright notice and this permission notice
14// shall be included in all copies or substantial portions
15// of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25// DEALINGS IN THE SOFTWARE.
26
27//! Shared utilities for `jsonrpsee`.
28
29#![warn(missing_docs, missing_debug_implementations, missing_copy_implementations, unreachable_pub)]
30#![cfg_attr(not(test), warn(unused_crate_dependencies))]
31#![cfg_attr(docsrs, feature(doc_cfg))]
32
33// Macros useful internally within this crate, but not to be exposed outside of it.
34#[macro_use]
35mod macros;
36
37/// Error type.
38pub mod error;
39
40/// Traits
41pub mod traits;
42
43/// RPC Parameters.
44pub mod params;
45
46cfg_http_helpers! {
47	pub mod http_helpers;
48}
49
50cfg_server! {
51	pub mod id_providers;
52	pub mod server;
53}
54
55cfg_client! {
56	pub mod client;
57	pub use client::Error as ClientError;
58}
59
60/// Shared tracing helpers to trace RPC calls.
61pub mod tracing;
62pub use async_trait::async_trait;
63pub use error::{RegisterMethodError, StringError};
64
65/// JSON-RPC result.
66pub type RpcResult<T> = std::result::Result<T, jsonrpsee_types::ErrorObjectOwned>;
67
68/// Empty server `RpcParams` type to use while registering modules.
69pub type EmptyServerParams = Vec<()>;
70
71#[doc(hidden)]
72mod proc_macros_support;
73
74/// Re-exports for proc-macro library to not require any additional
75/// dependencies to be explicitly added on the client side.
76#[doc(hidden)]
77pub mod __reexports {
78	pub use async_trait::async_trait;
79	pub use serde;
80	pub use serde_json;
81
82	// Needed for the params parsing in the proc macro API.
83	cfg_client_or_server! {
84		pub use tokio;
85	}
86
87	pub use super::proc_macros_support::*;
88}
89
90pub use serde::{de::DeserializeOwned, Serialize};
91pub use serde_json::{
92	to_value as to_json_value, value::to_raw_value as to_json_raw_value, value::RawValue as JsonRawValue,
93	Value as JsonValue,
94};
95pub use std::borrow::Cow;
96
97/// Ten megabytes.
98pub const TEN_MB_SIZE_BYTES: u32 = 10 * 1024 * 1024;
99
100/// The return type if the subscription wants to return `Result`.
101pub type SubscriptionResult = Result<(), StringError>;
102
103/// Type erased error.
104pub type BoxError = Box<dyn std::error::Error + Send + Sync>;
jsonrpsee_core/lib.rs

jsonrpsee_core/
lib.rs
