Struct tonic::service::Routes

pub struct Routes { /* private fields */ }

A Service router.

Implementations

impl Routes

pub fn new<S>(svc: S) -> Self

where S: Service<Request<BoxBody>, Response = Response<BoxBody>, Error = Infallible> + NamedService + Clone + Send + 'static, S::Future: Send + 'static, S::Error: Into<Box<dyn Error + Send + Sync>> + Send,

Create a new routes with svc already added to it.

pub fn builder() -> RoutesBuilder

Create a new empty builder.

pub fn add_service<S>(self, svc: S) -> Self

where S: Service<Request<BoxBody>, Response = Response<BoxBody>, Error = Infallible> + NamedService + Clone + Send + 'static, S::Future: Send + 'static, S::Error: Into<Box<dyn Error + Send + Sync>> + Send,

Add a new service.

pub fn prepare(self) -> Self

This makes axum perform update some internals of the router that improves perf.

See https://docs.rs/axum/latest/axum/routing/struct.Router.html#a-note-about-performance

pub fn into_router(self) -> Router

👎Deprecated since 0.12.2: Use Routes::into_axum_router instead.

Convert this Routes into an axum::Router.

pub fn into_axum_router(self) -> Router

Convert this Routes into an axum::Router.

Trait Implementations

impl Clone for Routes

fn clone(&self) -> Routes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Routes

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

Formats the value using the given formatter.

impl Default for Routes

fn default() -> Self

Returns the “default value” for a type.

impl From<Router> for Routes

fn from(router: Router) -> Self

Converts to this type from the input type.

impl Service<Request<UnsyncBoxBody<Bytes, Status>>> for Routes

type Response = Response<UnsyncBoxBody<Bytes, Status>>

Responses given by the service.

type Error = Box<dyn Error + Send + Sync>

Errors produced by the service.

type Future = RoutesFuture

The future response value.

fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<BoxBody>) -> Self::Future

Process the request and return the response asynchronously.