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, FutureResult<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_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: Into<HashMap<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, FutureResult<Option<Output>, ()>>>

Handle single call asynchronously.

Trait Implementations

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, Noop>

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

Converts to this type from the input type.