Skip to main content

JsonRpcClient

Struct JsonRpcClient 

Source
pub struct JsonRpcClient<T: Transport> { /* private fields */ }
Expand description

JSON-RPC 2.0 client with bidirectional communication.

Features:

  • Send requests and await responses (with timeout)
  • Send notifications (fire-and-forget)
  • Handle incoming notifications via callback
  • Handle incoming requests (server-to-client calls) via callback
  • Background read loop with automatic dispatch

Implementations§

Source§

impl<T: Transport + 'static> JsonRpcClient<T>

Source

pub fn new(transport: T) -> Self

Create a new JSON-RPC client wrapping a transport.

Source

pub async fn start(&self) -> Result<()>

Start the background read loop.

Source

pub async fn stop(&self)

Stop the client.

Source

pub fn is_running(&self) -> bool

Check if client is running.

Source

pub async fn set_notification_handler<F>(&self, handler: F)
where F: Fn(&str, &Value) + Send + Sync + 'static,

Set handler for incoming notifications.

Source

pub async fn set_request_handler<F>(&self, handler: F)
where F: Fn(&str, &Value) -> RequestHandlerFuture + Send + Sync + 'static,

Set handler for incoming requests.

Source

pub async fn invoke(&self, method: &str, params: Option<Value>) -> Result<Value>

Send a request and await response.

Source

pub async fn invoke_with_timeout( &self, method: &str, params: Option<Value>, timeout: Duration, ) -> Result<Value>

Send a request with custom timeout.

Source

pub async fn notify(&self, method: &str, params: Option<Value>) -> Result<()>

Send a notification (no response expected).

Source

pub async fn send_response(&self, id: JsonRpcId, result: Value) -> Result<()>

Send a response to an incoming request.

Source

pub async fn send_error_response( &self, id: JsonRpcId, error: JsonRpcError, ) -> Result<()>

Send an error response to an incoming request.

Auto Trait Implementations§

§

impl<T> !Freeze for JsonRpcClient<T>

§

impl<T> !RefUnwindSafe for JsonRpcClient<T>

§

impl<T> Send for JsonRpcClient<T>

§

impl<T> Sync for JsonRpcClient<T>

§

impl<T> Unpin for JsonRpcClient<T>

§

impl<T> UnsafeUnpin for JsonRpcClient<T>

§

impl<T> !UnwindSafe for JsonRpcClient<T>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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