Struct Server 

pub struct Server { /* private fields */ }

A bound listener that has not started accepting yet.

Binding is separated from serving so the caller can learn the address — which matters when binding port 0 — without racing the accept loop.

Implementations

impl Server

pub async fn bind(addr: impl ToSocketAddrs) -> Result<Server, Error>

Binds a listener without accepting anything yet.

Errors

Returns std::io::Error if the address cannot be bound.

pub const fn with_config(self, config: ServeConfig) -> Server

Applies limits to this server.

pub fn local_addr(&self) -> Result<SocketAddr, Error>

The address actually bound, which is the only way to learn the port when binding to 0.

Errors

Returns std::io::Error if the socket cannot report its address.

pub async fn serve_with_shutdown( self, dispatcher: impl Dispatcher, shutdown: impl Future<Output = ()> + Send, ) -> ServeReport

Accepts until shutdown resolves, then ends the work in flight and drains.

The order is what makes it graceful:

1. Stop accepting. The listener is dropped.
2. End in-flight tasks. When the dispatcher has a request_handler, RequestHandler::finish_in_flight first lets tasks finish on their own for up to ServeConfig::completion_grace, then fires every remaining task’s cancellation token and waits up to ServeConfig::task_grace for the executors to act on it: cancel what they delegated, and end their tasks with a terminal event that reaches every open stream.
3. Drain connections, for up to ServeConfig::drain_timeout. Streams whose tasks have ended close on their own, so this is usually quick.

It used to drain first. An open SSE stream is a connection that does not close until its task ends, so the drain waited out its whole timeout on tasks nobody had cancelled, and a delegating executor’s downstream work outlived the process.

Returns once both phases have finished or run out of time — never before, which is the whole point of it existing. Call RequestHandler::shutdown after it to run the executor’s cleanup hook.

Trait Implementations

impl Debug for Server

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

Formats the value using the given formatter.