Struct jsonrpc_core::IoHandler

pub struct IoHandler<M: Metadata = ()>(_);

Simplified IoHandler with no Metadata associated with each request.

Implementations

impl IoHandler

pub fn new() -> Self

Creates new IoHandler without any metadata.

pub fn with_compatibility(compatibility: Compatibility) -> Self

Creates new IoHandler without any metadata compatible with specified protocol version.

impl<M: Metadata + Default> IoHandler<M>

pub fn handle_request(
    &self,
    request: &str
) -> FutureResult<FutureResponse, FutureOutput>

Handle given string request asynchronously.

pub fn handle_rpc_request(
    &self,
    request: Request
) -> FutureRpcResult<FutureResponse, FutureOutput>

Handle deserialized RPC request asynchronously.

pub fn handle_call(
    &self,
    call: Call
) -> Either<FutureOutput, Either<FutureOutput, Ready<Option<Output>>>>

Handle single Call asynchronously.

pub fn handle_request_sync(&self, request: &str) -> Option<String>

Handle given request synchronously - will block until response is available. If you have any asynchronous methods in your RPC it is much wiser to use handle_request instead and deal with asynchronous requests in a non-blocking fashion.

Methods from Deref<Target = MetaIoHandler<M>>

pub fn add_alias(&mut self, alias: &str, other: &str)

Adds an alias to a method.

pub fn add_sync_method<F>(&mut self, name: &str, method: F) where
    F: RpcMethodSync, 

Adds new supported synchronous method.

A backward-compatible wrapper.

pub fn add_method<F>(&mut self, name: &str, method: F) where
    F: RpcMethodSimple, 

Adds new supported asynchronous method.

pub fn add_notification<F>(&mut self, name: &str, notification: F) where
    F: RpcNotificationSimple, 

Adds new supported notification

pub fn add_method_with_meta<F>(&mut self, name: &str, method: F) where
    F: RpcMethod<T>, 

Adds new supported asynchronous method with metadata support.

pub fn add_notification_with_meta<F>(&mut self, name: &str, notification: F) where
    F: RpcNotification<T>, 

Adds new supported notification with metadata support.

pub fn extend_with<F>(&mut self, methods: F) where
    F: IntoIterator<Item = (String, RemoteProcedure<T>)>, 

Extend this MetaIoHandler with methods defined elsewhere.

pub fn handle_request_sync(&self, request: &str, meta: T) -> Option<String>

Handle given request synchronously - will block until response is available. If you have any asynchronous methods in your RPC it is much wiser to use handle_request instead and deal with asynchronous requests in a non-blocking fashion.

pub fn handle_request(
    &self,
    request: &str,
    meta: T
) -> FutureResult<S::Future, S::CallFuture>

Handle given request asynchronously.

pub fn handle_rpc_request(
    &self,
    request: Request,
    meta: T
) -> FutureRpcResult<S::Future, S::CallFuture>

Handle deserialized RPC request.

pub fn handle_call(
    &self,
    call: Call,
    meta: T
) -> Either<S::CallFuture, Either<FutureOutput, Ready<Option<Output>>>>

Handle single call asynchronously.

pub fn iter(&self) -> impl Iterator<Item = (&String, &RemoteProcedure<T>)>

Returns an iterator visiting all methods in arbitrary order.

Trait Implementations

impl<M: Clone + Metadata> Clone for IoHandler<M>

fn clone(&self) -> IoHandler<M>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: Debug + Metadata> Debug for IoHandler<M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: Default + Metadata> Default for IoHandler<M>

fn default() -> IoHandler<M>

Returns the “default value” for a type.

impl<M: Metadata> Deref for IoHandler<M>

type Target = MetaIoHandler<M>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M: Metadata> DerefMut for IoHandler<M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<IoHandler<()>> for MetaIoHandler<()>

fn from(io: IoHandler) -> Self

Performs the conversion.

impl<T: Metadata> IntoIterator for IoHandler<T>

type Item = <MetaIoHandler<T> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <MetaIoHandler<T> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<M: Metadata> IoHandlerExtension<M> for IoHandler<M>

fn augment<S: Middleware<M>>(self, handler: &mut MetaIoHandler<M, S>)

Extend given handler with additional methods.