Struct tari_shutdown::Shutdown

pub struct Shutdown { /* fields omitted */ }

Trigger for shutdowns.

Use to_signal to create a future which will resolve when Shutdown is triggered. Use trigger to signal. All signals will resolve.

Note: This will trigger when dropped, so the Shutdown instance should be held as long as required by the application.

Implementations

impl Shutdown

pub fn new() -> Self

Create a new Shutdown

pub fn on_triggered<F>(&mut self, on_trigger: F) -> &mut Self where
    F: FnOnce() + Send + Sync + 'static, 

Set the on_triggered callback

pub fn to_signal(&self) -> ShutdownSignal

Convert this into a ShutdownSignal without consuming the struct.

pub fn trigger(&mut self) -> Result<(), ()>

Trigger any listening signals

pub fn is_triggered(&self) -> bool

Trait Implementations

impl Default for Shutdown

fn default() -> Self

Returns the "default value" for a type.

impl Drop for Shutdown

fn drop(&mut self)

Executes the destructor for this type.