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

pub fn into_service<ResBody>(self) -> L::Service
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>>,

Create a tower service out of a router.

Trait Implementations§

source§

impl<L: Debug> Debug for Router<L>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<L> Freeze for Router<L>
where L: Freeze,

§

impl<L = Identity> !RefUnwindSafe for Router<L>

§

impl<L> Send for Router<L>
where L: Send,

§

impl<L = Identity> !Sync for Router<L>

§

impl<L> Unpin for Router<L>
where L: Unpin,

§

impl<L = Identity> !UnwindSafe for Router<L>

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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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