Struct GracefulShutdown

pub struct GracefulShutdown { /* private fields */ }

A graceful shutdown utility

Implementations

impl GracefulShutdown

pub fn new() -> Self

Create a new graceful shutdown helper.

pub fn watch<C: GracefulConnection>( &self, conn: C, ) -> impl Future<Output = C::Output>

Wrap a future for graceful shutdown watching.

pub fn watcher(&self) -> Watcher

Create an owned type that can watch a connection.

This method allows created an owned type that can be sent onto another task before calling Watcher::watch().

pub async fn shutdown(self)

Signal shutdown for all watched connections.

This returns a Future which will complete once all watched connections have shutdown.

pub fn count(&self) -> usize

Returns the number of the watching connections.

Trait Implementations

impl Debug for GracefulShutdown

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GracefulShutdown

fn default() -> Self

Returns the “default value” for a type.