Struct GracefulShutdown 

pub struct GracefulShutdown { /* private fields */ }

Graceful shutdown handler

Provides utilities for handling graceful shutdown of services.

Implementations

impl GracefulShutdown

pub fn new() -> Self

Create a new graceful shutdown handler with default settings

pub fn builder() -> GracefulShutdownBuilder

Create a builder for configuring the shutdown handler

pub fn timeout(&self) -> Duration

Get the shutdown timeout

pub fn token(&self) -> ShutdownToken

Get a token that can be used to check shutdown status

pub fn subscribe(&self) -> Receiver<ShutdownSignal>

Subscribe to shutdown signals

pub fn shutdown(&self)

Trigger a manual shutdown

pub async fn wait(&self) -> ShutdownSignal

Wait for a shutdown signal (SIGINT or SIGTERM)

Returns the signal that triggered the shutdown.

pub async fn wait_with_timeout(&self) -> Option<ShutdownSignal>

Wait for shutdown with a timeout

If the timeout expires before shutdown completes, returns None.

pub async fn run_until_shutdown<F, T>(&self, future: F) -> Option<T>

where F: Future<Output = T>,

Run a future until shutdown is requested

Returns the result of the future if it completes before shutdown, or None if shutdown was requested first.

pub fn spawn<F>(&self, name: &str, future: F) -> JoinHandle<Option<()>>

where F: Future<Output = ()> + Send + 'static,

Spawn a task that will be cancelled on shutdown

Trait Implementations

impl Default for GracefulShutdown

fn default() -> Self

Returns the “default value” for a type.

impl GracefulShutdownExt for GracefulShutdown

async fn perform_shutdown<F, Fut, E>(&self, cleanup_fn: F) -> Result<(), E>

where F: FnOnce() -> Fut + Send, Fut: Future<Output = Result<(), E>> + Send, E: Display + Send,

Perform graceful shutdown sequence with cleanup