Struct tonic::transport::server::Router

source ·

pub struct Router<L = Identity> { /* private fields */ }

Expand description

A stack based Service router.

Implementations§

source §

impl<L> Router<L>

source

pub fn add_service<S>(self, svc: S) -> Self
where S: Service<Request<Body>, Response = Response<BoxBody>, Error = Infallible> + NamedService + Clone + Send + 'static, S::Future: Send + 'static,

Add a new service to this router.

source

pub fn add_optional_service<S>(self, svc: Option<S>) -> Self
where S: Service<Request<Body>, Response = Response<BoxBody>, Error = Infallible> + NamedService + Clone + Send + 'static, S::Future: Send + 'static,

Add a new optional service to this router.

§Note

Even when the argument given is None this will capture all requests to this service name. As a result, one cannot use this to toggle between two identically named implementations.

source

pub fn into_router(self) -> Router

Convert this tonic Router into an axum Router consuming the tonic one.

source

pub async fn serve<ResBody>(self, addr: SocketAddr) -> Result<(), Error>
where L: Layer<Routes>, L::Service: Service<Request<Body>, Response = Response<ResBody>> + Clone + Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Future: Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Error: Into<Box<dyn Error + Send + Sync>> + Send, ResBody: Body<Data = Bytes> + Send + 'static, ResBody::Error: Into<Box<dyn Error + Send + Sync>>,

Consume this Server creating a future that will execute the server on tokio’s default executor.

source

pub async fn serve_with_shutdown<F: Future<Output = ()>, ResBody>( self, addr: SocketAddr, signal: F ) -> Result<(), Error>
where L: Layer<Routes>, L::Service: Service<Request<Body>, Response = Response<ResBody>> + Clone + Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Future: Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Error: Into<Box<dyn Error + Send + Sync>> + Send, ResBody: Body<Data = Bytes> + Send + 'static, ResBody::Error: Into<Box<dyn Error + Send + Sync>>,

Consume this Server creating a future that will execute the server on tokio’s default executor. And shutdown when the provided signal is received.

source

pub async fn serve_with_incoming<I, IO, IE, ResBody>( self, incoming: I ) -> Result<(), Error>
where I: Stream<Item = Result<IO, IE>>, IO: AsyncRead + AsyncWrite + Connected + Unpin + Send + 'static, IO::ConnectInfo: Clone + Send + Sync + 'static, IE: Into<Box<dyn Error + Send + Sync>>, L: Layer<Routes>, L::Service: Service<Request<Body>, Response = Response<ResBody>> + Clone + Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Future: Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Error: Into<Box<dyn Error + Send + Sync>> + Send, ResBody: Body<Data = Bytes> + Send + 'static, ResBody::Error: Into<Box<dyn Error + Send + Sync>>,

Consume this Server creating a future that will execute the server on the provided incoming stream of AsyncRead + AsyncWrite.

This method discards any provided Server TCP configuration.

source

pub async fn serve_with_incoming_shutdown<I, IO, IE, F, ResBody>( self, incoming: I, signal: F ) -> Result<(), Error>
where I: Stream<Item = Result<IO, IE>>, IO: AsyncRead + AsyncWrite + Connected + Unpin + Send + 'static, IO::ConnectInfo: Clone + Send + Sync + 'static, IE: Into<Box<dyn Error + Send + Sync>>, F: Future<Output = ()>, L: Layer<Routes>, L::Service: Service<Request<Body>, Response = Response<ResBody>> + Clone + Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Future: Send + 'static, <<L as Layer<Routes>>::Service as Service<Request<Body>>>::Error: Into<Box<dyn Error + Send + Sync>> + Send, ResBody: Body<Data = Bytes> + Send + 'static, ResBody::Error: Into<Box<dyn Error + Send + Sync>>,

Consume this Server creating a future that will execute the server on the provided incoming stream of AsyncRead + AsyncWrite. Similar to serve_with_shutdown this method will also take a signal future to gracefully shutdown the server.

This method discards any provided Server TCP configuration.

source