This Rust library consists of a convenient macro to specify on shutdown callbacks. This is useful for all runtimes you do not have control over. It's super simple and stripped-down.
The generated main() function of an "actix" web server is a good example. With the
exported macro on_shutdown!()
you can easily specify code, that should run during program
termination/shutdown.
With "runtimes you do not have control over" I mean that for example actix doesn't let you specify shutdown callbacks by itself. In such cases my macro may be a better option.
IMPORTANT: Use this on the top level of your main() or whatever your current runtimes main function is! The code gets executed when the context it lives in gets dropped. This can be called multiple times (at least with stable Rust 1.48.0) without problem.
rust
use simple_on_shutdown::on_shutdown;
// ...
on_shutdown!(println!("shutted down"));
```rust // Not recommended, old way
extern crate simpleonshutdown; // ... on_shutdown!(println!("shutted down")); ```
See also "example/"-dir in repository! ```rust use simpleonshutdown::on_shutdown;
fn main() { // some code ...
// Important that the returned value of the macro lives through
// the whole lifetime of main(). It gets dropped in the end.
on_shutdown!(println!("shut down with success"));
// some code ...
} ```
See also "example/"-dir in repository!
```rust use actixweb::{get, HttpServer, App, HttpResponse, Responder}; use simpleonshutdown::onshutdown;
async fn get_index() -> impl Responder { HttpResponse::Ok().body("Hello World") }
async fn main() -> std::io::Result<()> { // Important that the returned value of the macro lives through // the whole lifetime of main(). It gets dropped in the end. on_shutdown!({ // the actual code println!("This gets executed during shutdown. Don't to expensive operations here."); });
HttpServer::new(|| {
App::new()
.service(get_index)
})
.bind(format!("localhost:{}", 8080))?
.run()
.await
} ```