Struct axum_server::Handle

pub struct Handle { /* fields omitted */ }

A struct that can be passed to a server for additional utilites.

Example

use axum::{
    handler::get,
    Router,
};
use axum_server::Handle;
use tokio::time::{sleep, Duration};

#[tokio::main]
async fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, World!" }));

    let handle = Handle::new();

    tokio::spawn(shutdown_in_twenty_secs(handle.clone()));

    axum_server::bind("127.0.0.1:3000")
        .handle(handle)
        .serve(app)
        .await
        .unwrap();
}

async fn shutdown_in_twenty_secs(handle: Handle) {
    sleep(Duration::from_secs(20)).await;

    handle.shutdown();
}

Implementations

impl Handle

pub fn new() -> Self

Create a Handle.

pub fn shutdown(&self)

Signal server to shut down.

serve function will return when shutdown is complete.

pub fn graceful_shutdown(&self)

Signal server to gracefully shut down.

serve function will return when graceful shutdown is complete.

pub fn listening_addrs(&self) -> Option<Vec<SocketAddr>>

Get addresses that are being listened.

Ordered by first bind call to last bind call. Then ordered by first bind_rustls call to last bind_rustls call.

Always Some after listening returns.

pub async fn listening(&self)

Wait until server starts listening on all addresses.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Handle

fn default() -> Handle

Returns the “default value” for a type.