Struct ShutdownHook

pub struct ShutdownHook { /* private fields */ }

A named future that will be invoked after all the tasks are stopped. The future is expected to perform a cleanup or a shutdown of the service.

All the shutdown hooks will be executed sequentially, so they may assume that no other tasks are running at the moment of execution on the same node. However, an unique access to the database is not guaranteed, since the node may run in a distributed mode, so this should not be used for potentially destructive actions.

Implementations

impl ShutdownHook

pub fn new( name: &'static str, hook: impl Future<Output = Result<()>> + Send + 'static, ) -> Self

Trait Implementations

impl Debug for ShutdownHook

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

Formats the value using the given formatter.

impl IntoContext for ShutdownHook

fn into_context( self, context: &mut ServiceContext<'_>, ) -> Result<(), WiringError>