Crate safeword

Safeword is a library for gracefully ending a Tokio-based application upon receiving a signal.

This could be useful for cleaning up after a program cleanly exits. For example, you might have a server that listens on a Unix domain socket, which does not automatically delete the socket path after the object is dropped. You can run your application with Safeword::run instead of tokio::run and know whether your application was asked to stop, or stopped for another reason (such as the future finishing earlier than you expected).

Use this library with Safeword::run. Inspect the cause of why your code might have failed with Shutdown.

Structs

Safeword

A modified Tokio runtime that exits early on a signal.

Enums

Shutdown

Describes the possible reasons for the runtime to unexpectedly stop (that is, not stop because of a signal).