quic_rpc::server

Struct RpcChannel

Source
pub struct RpcChannel<S: Service, C: ServiceEndpoint<SC> = BoxedServiceEndpoint<S>, SC: Service = S> {
    pub send: C::SendSink,
    pub recv: C::RecvStream,
    pub map: Arc<dyn MapService<SC, S>>,
}
Expand description

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. SC is the service type that is compatible with the connection. C is the service endpoint from which the channel was created.

Fields§

§send: C::SendSink

Sink to send responses to the client.

§recv: C::RecvStream

Stream to receive requests from the client.

§map: Arc<dyn MapService<SC, S>>

Mapper to map between S and S2

Implementations§

Source§

impl<S, C> RpcChannel<S, C, S>
where S: Service, C: ServiceEndpoint<S>,

Source

pub fn new(send: C::SendSink, recv: C::RecvStream) -> Self

Create a new RPC channel.

Source§

impl<SC, S, C> RpcChannel<S, C, SC>
where S: Service, SC: Service, C: ServiceEndpoint<SC>,

Source

pub fn map<SNext>(self) -> RpcChannel<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.

Source§

impl<SC, C, S> RpcChannel<S, C, SC>
where SC: Service, C: ServiceEndpoint<SC>, S: Service,

Source

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<SC, C, M::Update, S>) -> Str + Send + 'static, Str: Stream<Item = M::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.

Source§

impl<S, C, SC> RpcChannel<S, C, SC>
where S: Service, SC: Service, C: ServiceEndpoint<SC>,

Source

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<SC, C, M::Update, S>) -> Fut + Send + 'static, Fut: Future<Output = M::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.

Source§

impl<S, C, SC> RpcChannel<S, C, SC>
where S: Service, SC: Service, C: ServiceEndpoint<SC>,

Source

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::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.

Source

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.

Source§

impl<S, C, SC> RpcChannel<S, C, SC>
where S: Service, SC: Service, C: ServiceEndpoint<SC>,

Source

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::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.

Source§

impl<SC, C, S> RpcChannel<S, C, SC>
where SC: Service, C: ServiceEndpoint<SC>, S: Service,

Source

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::Item, M::ItemError>: Into<S::Res> + TryFrom<S::Res>, Result<StreamCreated, M::CreateError>: Into<S::Res> + TryFrom<S::Res>, F: FnOnce(T, M) -> Fut + Send + 'static, Fut: Future<Output = Result<Str, M::CreateError>> + Send + 'static, Str: Stream<Item = Result<M::Item, M::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§

Source§

impl<S: Debug + Service, C: Debug + ServiceEndpoint<SC>, SC: Debug + Service> Debug for RpcChannel<S, C, SC>
where C::SendSink: Debug, C::RecvStream: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S, C, SC> Freeze for RpcChannel<S, C, SC>
where <C as ConnectionCommon<<SC as Service>::Req, <SC as Service>::Res>>::SendSink: Freeze, <C as ConnectionCommon<<SC as Service>::Req, <SC as Service>::Res>>::RecvStream: Freeze,

§

impl<S, C = ServerEndpoint<<S as Service>::Req, <S as Service>::Res>, SC = S> !RefUnwindSafe for RpcChannel<S, C, SC>

§

impl<S, C, SC> Send for RpcChannel<S, C, SC>

§

impl<S, C, SC> Sync for RpcChannel<S, C, SC>

§

impl<S, C, SC> Unpin for RpcChannel<S, C, SC>

§

impl<S, C = ServerEndpoint<<S as Service>::Req, <S as Service>::Res>, SC = S> !UnwindSafe for RpcChannel<S, C, SC>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more