jsonrpc_core/
calls.rs

1use crate::types::{Error, Params, Value};
2use crate::BoxFuture;
3use std::fmt;
4use std::future::Future;
5use std::sync::Arc;
6
7/// Metadata trait
8pub trait Metadata: Clone + Send + 'static {}
9impl Metadata for () {}
10impl<T: Metadata> Metadata for Option<T> {}
11impl<T: Metadata> Metadata for Box<T> {}
12impl<T: Sync + Send + 'static> Metadata for Arc<T> {}
13
14/// A future-conversion trait.
15pub trait WrapFuture<T, E> {
16	/// Convert itself into a boxed future.
17	fn into_future(self) -> BoxFuture<Result<T, E>>;
18}
19
20impl<T: Send + 'static, E: Send + 'static> WrapFuture<T, E> for Result<T, E> {
21	fn into_future(self) -> BoxFuture<Result<T, E>> {
22		Box::pin(async { self })
23	}
24}
25
26impl<T, E> WrapFuture<T, E> for BoxFuture<Result<T, E>> {
27	fn into_future(self) -> BoxFuture<Result<T, E>> {
28		self
29	}
30}
31
32/// A synchronous or asynchronous method.
33pub trait RpcMethodSync: Send + Sync + 'static {
34	/// Call method
35	fn call(&self, params: Params) -> BoxFuture<crate::Result<Value>>;
36}
37
38/// Asynchronous Method
39pub trait RpcMethodSimple: Send + Sync + 'static {
40	/// Output future
41	type Out: Future<Output = Result<Value, Error>> + Send;
42	/// Call method
43	fn call(&self, params: Params) -> Self::Out;
44}
45
46/// Asynchronous Method with Metadata
47pub trait RpcMethod<T: Metadata>: Send + Sync + 'static {
48	/// Call method
49	fn call(&self, params: Params, meta: T) -> BoxFuture<crate::Result<Value>>;
50}
51
52/// Notification
53pub trait RpcNotificationSimple: Send + Sync + 'static {
54	/// Execute notification
55	fn execute(&self, params: Params);
56}
57
58/// Notification with Metadata
59pub trait RpcNotification<T: Metadata>: Send + Sync + 'static {
60	/// Execute notification
61	fn execute(&self, params: Params, meta: T);
62}
63
64/// Possible Remote Procedures with Metadata
65#[derive(Clone)]
66pub enum RemoteProcedure<T: Metadata> {
67	/// A method call
68	Method(Arc<dyn RpcMethod<T>>),
69	/// A notification
70	Notification(Arc<dyn RpcNotification<T>>),
71	/// An alias to other method,
72	Alias(String),
73}
74
75impl<T: Metadata> fmt::Debug for RemoteProcedure<T> {
76	fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
77		use self::RemoteProcedure::*;
78		match *self {
79			Method(..) => write!(fmt, "<method>"),
80			Notification(..) => write!(fmt, "<notification>"),
81			Alias(ref alias) => write!(fmt, "alias => {:?}", alias),
82		}
83	}
84}
85
86impl<F: Send + Sync + 'static, X: Send + 'static> RpcMethodSimple for F
87where
88	F: Fn(Params) -> X,
89	X: Future<Output = Result<Value, Error>>,
90{
91	type Out = X;
92	fn call(&self, params: Params) -> Self::Out {
93		self(params)
94	}
95}
96
97impl<F: Send + Sync + 'static, X: Send + 'static> RpcMethodSync for F
98where
99	F: Fn(Params) -> X,
100	X: WrapFuture<Value, Error>,
101{
102	fn call(&self, params: Params) -> BoxFuture<crate::Result<Value>> {
103		self(params).into_future()
104	}
105}
106
107impl<F: Send + Sync + 'static> RpcNotificationSimple for F
108where
109	F: Fn(Params),
110{
111	fn execute(&self, params: Params) {
112		self(params)
113	}
114}
115
116impl<F: Send + Sync + 'static, X: Send + 'static, T> RpcMethod<T> for F
117where
118	T: Metadata,
119	F: Fn(Params, T) -> X,
120	X: Future<Output = Result<Value, Error>>,
121{
122	fn call(&self, params: Params, meta: T) -> BoxFuture<crate::Result<Value>> {
123		Box::pin(self(params, meta))
124	}
125}
126
127impl<F: Send + Sync + 'static, T> RpcNotification<T> for F
128where
129	T: Metadata,
130	F: Fn(Params, T),
131{
132	fn execute(&self, params: Params, meta: T) {
133		self(params, meta)
134	}
135}
jsonrpc_core/calls.rs

jsonrpc_core/
calls.rs
