4 releases (2 breaking)

0.3.0 Apr 23, 2024
0.2.1 Mar 8, 2023
0.2.0 Jan 4, 2022
0.1.0 Nov 21, 2021

#619 in Asynchronous

Download history 88/week @ 2024-02-19 125/week @ 2024-02-26 96/week @ 2024-03-04 73/week @ 2024-03-11 95/week @ 2024-03-18 59/week @ 2024-03-25 86/week @ 2024-04-01 13/week @ 2024-04-08 167/week @ 2024-04-22 8/week @ 2024-04-29 6/week @ 2024-05-06 18/week @ 2024-05-13 35/week @ 2024-05-20 13/week @ 2024-05-27 11/week @ 2024-06-03

78 downloads per month

MIT license

34KB
417 lines

Elegant Departure

Crates.io License Build Status docs.rs

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
  • Tokio: Tokio integration example
  • Hyper: a shutdown example using the Hyper webserver
  • 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
}

Dependencies

~3–14MB
~122K SLoC