Struct RpcChannel

pub struct RpcChannel<S, C = BoxedStreamTypes<<S as Service>::Req, <S as Service>::Res>>
where
    S: Service,
    C: ChannelTypes<S>,
{
    pub send: <C as StreamTypes>::SendSink,
    pub recv: <C as StreamTypes>::RecvStream,
    /* private fields */
}

A channel for requests and responses for a specific service.

This just groups the sink and stream into a single type, and attaches the information about the service type.

Sink and stream are independent, so you can take the channel apart and use them independently.

Type parameters:

S is the service type. C is the service endpoint from which the channel was created.

Fields

send: <C as StreamTypes>::SendSink

Sink to send responses to the client.

recv: <C as StreamTypes>::RecvStream

Stream to receive requests from the client.

Implementations

impl<S, C> RpcChannel<S, C>

where S: Service, C: StreamTypes<In = <S as Service>::Req, Out = <S as Service>::Res>,

pub fn new( send: <C as StreamTypes>::SendSink, recv: <C as StreamTypes>::RecvStream, ) -> RpcChannel<S, C>

Create a new RPC channel.

pub fn boxed(self) -> RpcChannel<S>

where <C as ConnectionErrors>::SendError: Into<Error> + Send + Sync + 'static, <C as ConnectionErrors>::RecvError: Into<Error> + Send + Sync + 'static,

Convert this channel into a boxed channel.

pub fn map<SNext>( self, ) -> RpcChannel<SNext, MappedStreamTypes<<SNext as Service>::Req, <SNext as Service>::Res, C>>

where SNext: Service, <SNext as Service>::Req: TryFrom<<S as Service>::Req>, <S as Service>::Res: From<<SNext as Service>::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<C, S> RpcChannel<S, C>

where C: StreamTypes<In = <S as Service>::Req, Out = <S as Service>::Res>, S: Service,

pub async fn bidi_streaming<M, F, Str, T>( self, req: M, target: T, f: F, ) -> Result<(), RpcServerError<C>>

where M: BidiStreamingMsg<S>, F: FnOnce(T, M, UpdateStream<C, <M as BidiStreamingMsg<S>>::Update>) -> Str + Send + 'static, Str: Stream<Item = <M as BidiStreamingMsg<S>>::Response> + Send + 'static, T: Send + 'static,

handle the message M using the given function on the target object

If you want to support concurrent requests, you need to spawn this on a tokio task yourself.

impl<S, C> RpcChannel<S, C>

where S: Service, C: StreamTypes<In = <S as Service>::Req, Out = <S as Service>::Res>,

pub async fn client_streaming<M, F, Fut, T>( self, req: M, target: T, f: F, ) -> Result<(), RpcServerError<C>>

where M: ClientStreamingMsg<S>, F: FnOnce(T, M, UpdateStream<C, <M as ClientStreamingMsg<S>>::Update>) -> Fut + Send + 'static, Fut: Future<Output = <M as ClientStreamingMsg<S>>::Response> + Send + 'static, T: Send + 'static,

handle the message M using the given function on the target object

If you want to support concurrent requests, you need to spawn this on a tokio task yourself.

impl<S, C> RpcChannel<S, C>

where S: Service, C: StreamTypes<In = <S as Service>::Req, Out = <S as Service>::Res>,

pub async fn rpc<M, F, Fut, T>( self, req: M, target: T, f: F, ) -> Result<(), RpcServerError<C>>

where M: RpcMsg<S>, F: FnOnce(T, M) -> Fut, Fut: Future<Output = <M as RpcMsg<S>>::Response>, T: Send + 'static,

handle the message of type M using the given function on the target object

If you want to support concurrent requests, you need to spawn this on a tokio task yourself.

pub async fn rpc_map_err<M, F, Fut, T, R, E1, E2>( self, req: M, target: T, f: F, ) -> Result<(), RpcServerError<C>>

where M: RpcMsg<S, Response = Result<R, E2>>, F: FnOnce(T, M) -> Fut, Fut: Future<Output = Result<R, E1>>, E2: From<E1>, T: Send + 'static,

A rpc call that also maps the error from the user type to the wire type

This is useful if you want to write your function with a convenient error type like anyhow::Error, yet still use a serializable error type on the wire.

impl<S, C> RpcChannel<S, C>

where S: Service, C: StreamTypes<In = <S as Service>::Req, Out = <S as Service>::Res>,

pub async fn server_streaming<M, F, Str, T>( self, req: M, target: T, f: F, ) -> Result<(), RpcServerError<C>>

where M: ServerStreamingMsg<S>, F: FnOnce(T, M) -> Str + Send + 'static, Str: Stream<Item = <M as ServerStreamingMsg<S>>::Response> + Send + 'static, T: Send + 'static,

handle the message M using the given function on the target object

If you want to support concurrent requests, you need to spawn this on a tokio task yourself.

impl<S, C> RpcChannel<S, C>

where C: StreamTypes<In = <S as Service>::Req, Out = <S as Service>::Res>, S: Service,

pub async fn try_server_streaming<M, F, Fut, Str, T>( self, req: M, target: T, f: F, ) -> Result<(), RpcServerError<C>>

where M: TryServerStreamingMsg<S>, Result<<M as TryServerStreamingMsg<S>>::Item, <M as TryServerStreamingMsg<S>>::ItemError>: Into<<S as Service>::Res> + TryFrom<<S as Service>::Res>, Result<StreamCreated, <M as TryServerStreamingMsg<S>>::CreateError>: Into<<S as Service>::Res> + TryFrom<<S as Service>::Res>, F: FnOnce(T, M) -> Fut + Send + 'static, Fut: Future<Output = Result<Str, <M as TryServerStreamingMsg<S>>::CreateError>> + Send + 'static, Str: Stream<Item = Result<<M as TryServerStreamingMsg<S>>::Item, <M as TryServerStreamingMsg<S>>::ItemError>> + Send + 'static, T: Send + 'static,

handle the message M using the given function on the target object

If you want to support concurrent requests, you need to spawn this on a tokio task yourself.

Compared to RpcChannel::server_streaming, with this method the stream creation is via a function that returns a future that resolves to a stream.

Trait Implementations

impl<S, C> Debug for RpcChannel<S, C>

where S: Debug + Service, C: Debug + ChannelTypes<S>, <C as StreamTypes>::SendSink: Debug, <C as StreamTypes>::RecvStream: Debug,

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

Formats the value using the given formatter.