Struct ShutdownBuilder

pub struct ShutdownBuilder<T> { /* private fields */ }

ShutdownBuilder to build a Shutdown manager.

Implementations

impl ShutdownBuilder<WithSignal<Default>>

pub fn new() -> ShutdownBuilder<WithSignal<Default>>

Create a new ShutdownBuilder, which by default is ready to build a Shutdown.

pub fn without_signal(self) -> ShutdownBuilder<WithoutSignal>

Create a ShutdownBuilder without a trigger signal, meaning it will act like a WaitGroup.

pub fn with_signal<F>(self, future: F) -> ShutdownBuilder<WithSignal<F>>

where F: Future + Send + 'static,

Create a ShutdownBuilder with a custom Future signal.

impl<S> ShutdownBuilder<WithSignal<S>>

pub fn with_overwrite_fn<F, Fut>( self, f: F, ) -> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

where F: FnOnce() -> Fut + Send + 'static, Fut: Future + Send + 'static,

Create a ShutdownBuilder with a function which creates a future that will be awaited on as an alternative to waiting for all jobs to be complete.

pub fn with_delay(self, delay: Duration) -> ShutdownBuilder<WithSignal<S>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn maybe_with_delay( self, delay: Option<Duration>, ) -> ShutdownBuilder<WithSignal<S>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn set_delay( &mut self, delay: Duration, ) -> &mut ShutdownBuilder<WithSignal<S>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

impl<S, F> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

pub fn with_delay( self, delay: Duration, ) -> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn maybe_with_delay( self, delay: Option<Duration>, ) -> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn set_delay( &mut self, delay: Duration, ) -> &mut ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

impl ShutdownBuilder<WithoutSignal>

pub fn build(self) -> Shutdown

Build a Shutdown that acts like a WaitGroup.

impl<I> ShutdownBuilder<WithSignal<I>>

where I: IntoFuture,

pub fn build(self) -> Shutdown

Build a Shutdown which will allow a shutdown when the shutdown signal has been triggered AND all jobs are complete.

impl<I, F, Fut> ShutdownBuilder<WithSignalAndOverwriteFn<I, F>>

where I: IntoFuture, F: FnOnce() -> Fut + Send + 'static, Fut: Future + Send + 'static,

pub fn build(self) -> Shutdown

Build a Shutdown which will allow a shutdown when the shutdown signal has been triggered AND either all jobs are complete or the overwrite (force) signal has been triggered instead.

Trait Implementations

impl<T> Debug for ShutdownBuilder<T>

where T: Debug,

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

Formats the value using the given formatter.

impl Default for ShutdownBuilder<WithSignal<Default>>

fn default() -> ShutdownBuilder<WithSignal<Default>>

Returns the “default value” for a type.