Struct ServerBuilder 

pub struct ServerBuilder { /* private fields */ }

Typed builder for Server.

Construct via Server::builder.

Defaults

• bind address: 0.0.0.0:8080
• request timeout: 30s (applied via tower_http::timeout::TimeoutLayer)
• request body limit: 2 MiB (via Self::request_body_limit)
• tracing, request-id, health endpoint at /health: enabled
• CORS, compression, shutdown timeout: disabled / unset

Implementations

impl ServerBuilder

pub fn new() -> Self

Create a builder with defaults.

pub fn bind_addr(self, addr: impl Into<String>) -> Self

Set the bind address as a string (e.g. "0.0.0.0:3000", "[::]:8080").

pub fn bind_socket(self, addr: SocketAddr) -> Self

Set the bind address as a parsed SocketAddr.

pub fn route<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T, ()>, T: 'static,

Register a route, delegating to axum::Router::route.

pub fn merge(self, other: Router) -> Self

Merge another router (delegates to axum::Router::merge).

pub fn nest(self, prefix: &str, router: Router) -> Self

Mount a router at a nested path (delegates to axum::Router::nest).

pub fn request_timeout(self, d: Duration) -> Self

Set the per-request timeout. Default 30s.

The timeout wraps the entire request, including all middleware (tracing, CORS, custom layers) and the handler itself. Slow middleware will count against this deadline.

pub fn request_body_limit(self, bytes: usize) -> Self

Cap the size of incoming request bodies (default 2 MiB).

Requests with bodies larger than this receive an immediate 413 Payload Too Large response without buffering the full body. Mitigates slow-drip and body-bomb attacks against public-facing servers.

pub fn shutdown_timeout(self, d: Duration) -> Self

Bound the graceful shutdown drain (default: unbounded).

After the shutdown future resolves, axum stops accepting new connections and waits for in-flight requests to finish. Without a bound, a stuck handler keeps the server alive forever. Set this to enforce a deadline; in-flight requests still running after the deadline will be dropped and run_with_shutdown returns Err(Error::ShutdownTimeout).

pub fn disable_tracing(self) -> Self

Disable the default tracing middleware.

pub fn disable_request_id(self) -> Self

Disable the default request-id middleware.

pub fn enable_cors(self) -> Self

Enable CORS with permissive defaults (CorsLayer::permissive()).

pub fn enable_cors_with(self, layer: CorsLayer) -> Self

Enable CORS with a custom CorsLayer.

pub fn enable_compression(self) -> Self

Enable response compression (gzip/br/zstd).

pub fn health_path(self, path: &str) -> Self

Customise the health endpoint path. Default /health.

pub fn health_response<F, R>(self, responder: F) -> Self

where F: Fn() -> R + Send + Sync + 'static, R: IntoResponse + 'static,

Provide a custom responder for the health endpoint.

pub fn disable_health(self) -> Self

Disable the built-in health endpoint.

pub async fn build(self) -> Result<Server>

Bind the listener and build a Server ready to run.

Trait Implementations

impl Default for ServerBuilder

fn default() -> Self

Returns the “default value” for a type.