Struct HttpServer 

pub struct HttpServer { /* private fields */ }

Available on crate feature http-server only.

High-performance HTTP server built on axum.

Provides graceful shutdown, health endpoints, and Tower middleware support.

Implementations

impl HttpServer

pub fn new(config: HttpServerConfig) -> Self

Create a new HTTP server with the given configuration.

pub fn bind(address: impl Into<String>) -> Self

Create a new HTTP server bound to the specified address.

pub fn set_ready(&self, ready: bool)

Set the readiness state for the /health/ready endpoint.

pub fn is_ready(&self) -> bool

Get the current readiness state.

pub fn ready_flag(&self) -> Arc<AtomicBool>

Get a clone of the readiness flag for use in application state.

pub async fn serve(self, app: Router) -> Result<()>

Serve the given router until a shutdown signal is received.

This method will:

1. Bind to the configured address
2. Optionally add health check endpoints
3. Run until SIGTERM or SIGINT is received
4. Perform graceful shutdown

Errors

Returns an error if binding fails or the server encounters an error.

pub async fn serve_with_shutdown<F>( self, app: Router, shutdown: F, ) -> Result<()>

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

Serve with a custom shutdown signal.

This is useful for testing or when you need custom shutdown logic.

Errors

Returns an error if binding fails or the server encounters an error.

pub async fn serve_with_handle( self, app: Router, ) -> Result<(ShutdownHandle, ServerFuture)>

Serve and return a handle for programmatic shutdown.

Returns a ShutdownHandle that can be used to trigger shutdown.

Errors

Returns an error if binding fails.