Struct Serve

pub struct Serve<L, M, S> { /* private fields */ }

Available on crate feature tokio and (crate features http1 or http2) only.

Future returned by serve.

Implementations

impl<L, M, S> Serve<L, M, S>

where L: Listener,

pub fn with_graceful_shutdown<F>( self, signal: F, ) -> WithGracefulShutdown<L, M, S, F>

where F: Future<Output = ()> + Send + 'static,

Prepares a server to handle graceful shutdown when the provided future completes.

Example

use axum::{Router, routing::get};

let router = Router::new().route("/", get(|| async { "Hello, World!" }));

let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
axum::serve(listener, router)
    .with_graceful_shutdown(shutdown_signal())
    .await
    .unwrap();

async fn shutdown_signal() {
    // ...
}

Return Value

Similarly to serve, although this future resolves to io::Result<()>, it will never error. It returns Ok(()) only after the signal future completes.

pub fn local_addr(&self) -> Result<L::Addr>

Returns the local address this server is bound to.

Trait Implementations

impl<L, M, S> Debug for Serve<L, M, S>

where L: Debug + 'static, M: Debug,

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

Formats the value using the given formatter.

impl<L, M, S> IntoFuture for Serve<L, M, S>

where L: Listener, L::Addr: Debug, M: for<'a> Service<IncomingStream<'a, L>, Error = Infallible, Response = S> + Send + 'static, for<'a> <M as Service<IncomingStream<'a, L>>>::Future: Send, S: Service<Request, Response = Response, Error = Infallible> + Clone + Send + 'static, S::Future: Send,

type Output = Result<(), Error>

The output that the future will produce on completion.

type IntoFuture = ServeFuture

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.