Struct RpcClient

pub struct RpcClient<S, C = BoxedServiceConnection<S>, SC = S> { /* private fields */ }

A client for a specific service

This is a wrapper around a ServiceConnection that serves as the entry point for the client DSL.

Type parameters:

S is the service type that determines what interactions this client supports. SC is the service type that is compatible with the connection. C is the substream source.

Implementations

impl<S, C> RpcClient<S, C, S>

where S: Service, C: ServiceConnection<S>,

pub fn new(source: C) -> Self

Create a new rpc client for a specific Service given a compatible ServiceConnection.

This is where a generic typed connection is converted into a client for a specific service.

When creating a new client, the outer service type S and the inner service type SC that is compatible with the underlying connection will be identical.

You can get a client for a nested service by calling map.

impl<S, C, SC> RpcClient<S, C, SC>

where S: Service, SC: Service, C: ServiceConnection<SC>,

pub fn into_inner(self) -> C

Get the underlying connection

pub fn map<SNext>(self) -> RpcClient<SNext, C, SC>

where SNext: Service, SNext::Req: Into<S::Req> + TryFrom<S::Req>, SNext::Res: Into<S::Res> + TryFrom<S::Res>,

Map this channel’s service into an inner service.

This method is available if the required bounds are upheld: SNext::Req: Into<S::Req> + TryFrom<S::Req>, SNext::Res: Into<S::Res> + TryFrom<S::Res>,

Where SNext is the new service to map to and S is the current inner service.

This method can be chained infintely.

impl<S, C, SC> RpcClient<S, C, SC>

where SC: Service, C: ServiceConnection<SC>, S: Service,

pub async fn bidi<M>( &self, msg: M, ) -> Result<(UpdateSink<SC, C, M::Update, S>, BoxStreamSync<'static, Result<M::Response, ItemError<C>>>), Error<C>>

where M: BidiStreamingMsg<S>,

Bidi call to the server, request opens a stream, response is a stream

impl<S, C, SC> RpcClient<S, C, SC>

where S: Service, SC: Service, C: ServiceConnection<SC>,

pub async fn client_streaming<M>( &self, msg: M, ) -> Result<(UpdateSink<SC, C, M::Update, S>, Boxed<Result<M::Response, ItemError<C>>>), Error<C>>

where M: ClientStreamingMsg<S>,

Call to the server that allows the client to stream, single response

impl<S, C, SC> RpcClient<S, C, SC>

where S: Service, SC: Service, C: ServiceConnection<SC>,

pub async fn rpc<M>(&self, msg: M) -> Result<M::Response, Error<C>>

where M: RpcMsg<S>,

RPC call to the server, single request, single response

impl<S, C, SC> RpcClient<S, C, SC>

where SC: Service, C: ServiceConnection<SC>, S: Service,

pub async fn server_streaming<M>( &self, msg: M, ) -> Result<BoxStreamSync<'static, Result<M::Response, ItemError<C>>>, Error<C>>

where M: ServerStreamingMsg<S>,

Bidi call to the server, request opens a stream, response is a stream

impl<S, C, SC> RpcClient<S, C, SC>

where SC: Service, C: ServiceConnection<SC>, S: Service,

pub async fn try_server_streaming<M>( &self, msg: M, ) -> Result<BoxStreamSync<'static, Result<M::Item, ItemError<C, M::ItemError>>>, Error<C, M::CreateError>>

where M: TryServerStreamingMsg<S>, Result<M::Item, M::ItemError>: Into<S::Res> + TryFrom<S::Res>, Result<StreamCreated, M::CreateError>: Into<S::Res> + TryFrom<S::Res>,

Bidi call to the server, request opens a stream, response is a stream

Trait Implementations

impl<S, C, SC> AsRef<C> for RpcClient<S, C, SC>

where S: Service, SC: Service, C: ServiceConnection<SC>,

fn as_ref(&self) -> &C

Converts this type into a shared reference of the (usually inferred) input type.

impl<SC, S, C: Clone> Clone for RpcClient<S, C, SC>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug, C: Debug, SC: Debug> Debug for RpcClient<S, C, SC>

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

Formats the value using the given formatter.