Struct jsonrpc_core::MetaIoHandler

pub struct MetaIoHandler<T: Metadata, S: Middleware<T> = Noop> { /* fields omitted */ }

Request handler

By default compatible only with jsonrpc v2

Implementations

impl<T: Metadata> MetaIoHandler<T>

pub fn with_compatibility(compatibility: Compatibility) -> Self

Creates new MetaIoHandler compatible with specified protocol version.

impl<T: Metadata, S: Middleware<T>> MetaIoHandler<T, S>

pub fn new(compatibility: Compatibility, middleware: S) -> Self

Creates new MetaIoHandler

pub fn with_middleware(middleware: S) -> Self

Creates new MetaIoHandler with specified middleware.

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: 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, FutureResult<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<T: Clone + Metadata, S: Clone + Middleware<T>> Clone for MetaIoHandler<T, S>

fn clone(&self) -> MetaIoHandler<T, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Metadata, S: Debug + Middleware<T>> Debug for MetaIoHandler<T, S>

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

Formats the value using the given formatter.

impl<T: Metadata> Default for MetaIoHandler<T>

fn default() -> Self

Returns the "default value" for a type.

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

fn from(io: IoHandler) -> Self

Performs the conversion.

impl<T: Metadata, S: Middleware<T>> IntoIterator for MetaIoHandler<T, S>

type Item = (String, RemoteProcedure<T>)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, RemoteProcedure<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Metadata, S: Middleware<T>> IntoIterator for &'a MetaIoHandler<T, S>

type Item = (&'a String, &'a RemoteProcedure<T>)

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, RemoteProcedure<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<M: Metadata, S2: Middleware<M>> IoHandlerExtension<M> for MetaIoHandler<M, S2>

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

Extend given handler with additional methods.