Adding `elegant_departure` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add elegant-departure

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

elegant-departure = "0.3.2"

The elegant_departure library will be automatically available globally. Read the elegant_departure library documentation.

Back to the crate overview.

Readme

Elegant Departure

Rust crate to simplify graceful async shutdowns:

Easy to use with a minimal API
Runtime independent (works with tokio, async-std, smol, …)
Additional integrations for tokio (shutdown on ctrl-c, signals etc.)

Usage

This crate is on crates.io and can be used by adding it to your dependencies in your project's Cargo.toml.

[dependencies]
elegant-departure = "0.3"

For a optional tokio integration, you need to enable the tokio feature:

[dependencies]
elegant-departure = { version = "0.3", features = "tokio" }

Example

Examples can be found in the example directory:

Simple: simple example without tokio integration
Axum: Axum integration example
Axum Services: Axum integration example with multiple background services
Tokio: Tokio integration example
Worker: example implementation of a worker using select!
Smol: example using the smol runtime
Async Std: example using the async_std runtime

Minimal example using the tokio integration:

use std::time::Duration;

async fn worker(name: &'static str) {
    let guard = elegant_departure::get_shutdown_guard();

    println!("[{}] working", name);

    guard.wait().await;
    println!("[{}] shutting down", name);

    tokio::time::sleep(Duration::from_secs(1)).await;
    println!("[{}] done", name);
}

#[tokio::main]
async fn main() {
    tokio::spawn(worker("worker 1"));
    tokio::spawn(worker("worker 2"));

    elegant_departure::tokio::depart()
        // Shutdown on Ctrl+C and SIGTERM
        .on_termination()
        .await
}

Supported Rust Versions

The crate tries to not break MSRV compatibility but makes no guarantees about the Rust version. Although you can expect Rust version compatibility of at least 6 months.

The current MSRV is 1.80.

Adding elegant_departure library as a dependency

Adding `elegant_departure` library as a dependency