Struct graceful_shutdown::Shutdown

pub struct Shutdown { /* fields omitted */ }

Future for graceful shutdown.

Implementations

impl Shutdown

pub fn new() -> Self

pub fn handle(&self) -> Handle

Get a reference to manage the Shutdown

pub fn with_terminator<T: Future<Output = ()>>(
    self,
    terminator: T
) -> WithTerminator<T>

Add an early termination condition.

After shutdown has been initiated, the terminator future will be run, and if it completes before all tasks are completed the shutdown future will complete, thus finishing the shutdown even if there are outstanding tasks. This can be useful for using a timeout or signal (or combination) to force a full shutdown even if one or more tasks are taking longer than expected to finish.

Note that terminator will not start to be polled until after shutdown has been initiated. However, you may need to delay creation of the actual timeout future until the first poll, so that the end time is set correctly. This can be done using something like

let shutdown = Shutdown::new().with_terminator(async {
    tokio::time::sleep(Duration::from_secs(30)).await;
});

Trait Implementations

impl Future for Shutdown

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.