Struct jsonrpsee_core::server::rpc_module::Methods
source · [−]pub struct Methods { /* private fields */ }
server
only.Expand description
Reference-counted, clone-on-write collection of synchronous and asynchronous methods.
Implementations
sourceimpl Methods
impl Methods
sourcepub fn initialize_resources(self, resources: &Resources) -> Result<Self, Error>
pub fn initialize_resources(self, resources: &Resources) -> Result<Self, Error>
Initialize resources for all methods in this collection. This method has no effect if called more than once.
sourcepub fn merge(&mut self, other: impl Into<Methods>) -> Result<(), Error>
pub fn merge(&mut self, other: impl Into<Methods>) -> Result<(), Error>
Merge two Methods
’s by adding all MethodCallback
s from other
into self
.
Fails if any of the methods in other
is present already.
sourcepub fn method(&self, method_name: &str) -> Option<&MethodCallback>
pub fn method(&self, method_name: &str) -> Option<&MethodCallback>
Returns the method callback.
sourcepub fn method_with_name(
&self,
method_name: &str
) -> Option<(&'static str, &MethodCallback)>
pub fn method_with_name(
&self,
method_name: &str
) -> Option<(&'static str, &MethodCallback)>
Returns the method callback along with its name. The returned name is same as the
method_name
, but its lifetime bound is 'static
.
sourcepub async fn call<Params: ToRpcParams, T: DeserializeOwned>(
&self,
method: &str,
params: Params
) -> Result<T, Error>
pub async fn call<Params: ToRpcParams, T: DeserializeOwned>(
&self,
method: &str,
params: Params
) -> Result<T, Error>
Helper to call a method on the RPC module
without having to spin up a server.
The params must be serializable as JSON array, see ToRpcParams
for further documentation.
Returns the decoded value of the result field
in JSON-RPC response if succesful.
Examples
#[tokio::main]
async fn main() {
use jsonrpsee::RpcModule;
let mut module = RpcModule::new(());
module.register_method("echo_call", |params, _| {
params.one::<u64>().map_err(Into::into)
}).unwrap();
let echo: u64 = module.call("echo_call", [1_u64]).await.unwrap();
assert_eq!(echo, 1);
}
sourcepub async fn raw_json_request(
&self,
call: &str
) -> Result<(String, UnboundedReceiver<String>), Error>
pub async fn raw_json_request(
&self,
call: &str
) -> Result<(String, UnboundedReceiver<String>), Error>
Make a request (JSON-RPC method call or subscription) by using raw JSON.
Returns the raw JSON response to the call and a stream to receive notifications if the call was a subscription.
Examples
#[tokio::main]
async fn main() {
use jsonrpsee::RpcModule;
use jsonrpsee::types::Response;
use futures_util::StreamExt;
let mut module = RpcModule::new(());
module.register_subscription("hi", "hi", "goodbye", |_, pending, _| {
pending.accept().unwrap().send(&"one answer").unwrap();
}).unwrap();
let (resp, mut stream) = module.raw_json_request(r#"{"jsonrpc":"2.0","method":"hi","id":0}"#).await.unwrap();
let resp = serde_json::from_str::<Response<u64>>(&resp).unwrap();
let sub_resp = stream.next().await.unwrap();
assert_eq!(
format!(r#"{{"jsonrpc":"2.0","method":"hi","params":{{"subscription":{},"result":"one answer"}}}}"#, resp.result),
sub_resp
);
}
sourcepub async fn subscribe(
&self,
sub_method: &str,
params: impl ToRpcParams
) -> Result<Subscription, Error>
pub async fn subscribe(
&self,
sub_method: &str,
params: impl ToRpcParams
) -> Result<Subscription, Error>
Helper to create a subscription on the RPC module
without having to spin up a server.
The params must be serializable as JSON array, see ToRpcParams
for further documentation.
Returns Subscription
on success which can used to get results from the subscriptions.
Examples
#[tokio::main]
async fn main() {
use jsonrpsee::{RpcModule, types::EmptyParams};
let mut module = RpcModule::new(());
module.register_subscription("hi", "hi", "goodbye", |_, pending, _| {
pending.accept().unwrap().send(&"one answer").unwrap();
}).unwrap();
let mut sub = module.subscribe("hi", EmptyParams::new()).await.unwrap();
// In this case we ignore the subscription ID,
let (sub_resp, _sub_id) = sub.next::<String>().await.unwrap().unwrap();
assert_eq!(&sub_resp, "one answer");
}
sourcepub fn method_names(&self) -> impl Iterator<Item = &'static str> + '_
pub fn method_names(&self) -> impl Iterator<Item = &'static str> + '_
Returns an Iterator
with all the method names registered on this server.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Methods
impl Send for Methods
impl Sync for Methods
impl Unpin for Methods
impl !UnwindSafe for Methods
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more