Struct ServerBuilder 

pub struct ServerBuilder { /* private fields */ }

Builder for configuring and starting an HTTP server.

Implementations

impl ServerBuilder

pub fn with_cors(self, config: CorsConfig) -> Self

Add CORS middleware with the given configuration.

pub fn with_body_limit(self, max_bytes: u64) -> Self

Add a request body size limit (in bytes).

pub fn with_rate_limiter(self, limiter: RateLimiter) -> Self

Add rate limiting middleware.

pub fn with_timeout(self, duration: Duration) -> Self

Add a request processing timeout.

pub fn with_max_connections(self, n: usize) -> Self

Set a maximum number of concurrent connections.

pub fn with_tcp_nodelay(self, nodelay: bool) -> Self

Enable or disable TCP_NODELAY on accepted connections.

pub fn with_tcp_keepalive(self, duration: Duration) -> Self

Set the TCP keepalive idle time for accepted connections.

pub fn with_http2_settings(self, settings: ServerHttp2Settings) -> Self

Set HTTP/2 server-side connection tuning parameters.

pub fn with_graceful_shutdown<F>(self, signal: F) -> Self

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

Set a graceful shutdown signal.

pub fn shutdown_on_ctrl_c(self) -> Self

Convenience: shut down on Ctrl+C.

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

Start the server with the given router.

This function runs until the graceful shutdown signal fires or the server encounters a fatal error.

pub async fn serve_with_addr( self, router: Router, ) -> Result<(SocketAddr, JoinHandle<Result<(), OxiHttpError>>), OxiHttpError>

Start the server and return the bound SocketAddr plus a future that runs the server. Useful for tests where you need the address before the server starts accepting.

impl ServerBuilder

pub async fn listen(self) -> Result<BoundServer, OxiHttpError>

Bind the TCP port eagerly and return a BoundServer handle.

Useful when you need the actual bound address (e.g. when binding port 0) before the server starts accepting connections.

let bound = Server::bind("127.0.0.1:0").listen().await?;
let port = bound.local_addr().port();
println!("Listening on port {port}");
bound.serve(Router::new()).await?;

Trait Implementations

impl Debug for ServerBuilder

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

Formats the value using the given formatter.