Struct ConnectionShutdown 

pub struct ConnectionShutdown { /* private fields */ }

A handle to the connection that dispatched the current request.

axum-server adds this to the extensions of every request, so a handler can close the connection it is running on:

use axum::{extract::Extension, routing::get, Router};
use axum_server::ConnectionShutdown;

async fn handle(Extension(shutdown): Extension<ConnectionShutdown>) -> &'static str {
    shutdown.graceful_shutdown();
    "goodbye"
}

let app: Router = Router::new().route("/", get(handle));

The handle can be moved into another task to close the connection later, for example to enforce a deadline on a slow client.

An HTTP/2 connection carries many streams, so closing it closes all of them.

Implementations

impl ConnectionShutdown

pub fn shutdown(&self)

Close the connection immediately.

The in-flight request is cancelled, so its response may not be sent. Use graceful_shutdown to let the response finish.

pub fn graceful_shutdown(&self)

Close the connection after the in-flight response is sent.

The current response is still delivered and no further requests are accepted on the connection.

Trait Implementations

impl Clone for ConnectionShutdown

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionShutdown

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

Formats the value using the given formatter.