Crate simple_on_shutdown[][src]

Expand description

This crate consists of a convenient macro to specify on shutdown callbacks called on_shutdown. It takes code that should be executed when your program exits (gracefully).

Internally it creates a FnOnce-closure that gets executed when the context gets dropped. This macro can be called multiple times (at least with stable Rust 1.48.0) without problems.

In theory this macro can be used everywhere where the context gets dropped. But it has a nice expressive name so that one exactly knows what it should achieve in code. A good example is the main() function in an actix-web-Server or a tokio runtime. For example you want to log to a file when the server was shut down.

There is no guarantee that this gets executed during “non-regular” shutdown scenarios, like when receiving CTRL+C / SIGINT / SIGTERM. This depends on whether your application properly handles signals and if the operating system gives the application time before it gets totally killed/stopped.

Macros

on_shutdown

This crate consists of a convenient macro to specify on shutdown callbacks called on_shutdown. It takes code that should be executed when your program exits (gracefully).

Structs

OnShutdownCallback

PRIVATE! Use on_shutdown.