Skip to main content

Methods

Struct Methods 

Source
pub struct Methods { /* private fields */ }
Expand description

Registry of JSON-RPC methods with a builder pattern.

Methods allows you to register JSON-RPC method handlers using a fluent builder API. The registered methods can then be passed to the serve function to start a JSON-RPC server.

§Example

use json_rpc::Methods;

async fn echo(params: serde_json::Value) -> Result<serde_json::Value, json_rpc::Error> {
    Ok(params)
}

let methods = Methods::new()
    .add("echo", echo);

Implementations§

Source§

impl Methods

Source

pub fn new() -> Self

Create a new empty method registry.

Source

pub fn add<F, P, R, Fut>(self, method: &str, handler: F) -> Self
where F: Fn(P) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R, Error>> + Send + Sync + 'static, P: DeserializeOwned + Send + Sync + 'static, R: Serialize + Send + Sync + 'static,

Register a JSON-RPC method handler.

The handler must be an async function that takes deserialized parameters and returns a Result with either the return value or an Error.

§Example
use json_rpc::Methods;
use serde_json::Value;

async fn add(params: (i32, i32)) -> Result<i32, json_rpc::Error> {
    Ok(params.0 + params.1)
}

let methods = Methods::new()
    .add("add", add);
Source

pub async fn process_message(&self, json_str: &str) -> Option<String>

Process a JSON-RPC message and return the response JSON string (if any).

This helper method is used by transport implementations to process incoming JSON-RPC messages. It handles:

  • JSON parsing and validation
  • Message type detection (request, notification, batch, response)
  • Method routing and execution
  • Error handling and response generation

Trait Implementations§

Source§

impl Default for Methods

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,