Struct ShutdownGuard

pub struct ShutdownGuard(/* private fields */);

A guard, linked to a Shutdown struct, prevents the Shutdown::shutdown future from completing.

Can be cloned to create multiple ShutdownGuards and can be downgraded to a WeakShutdownGuard to no longer prevent the Shutdown::shutdown future from completing.

Implementations

impl ShutdownGuard

pub async fn cancelled(&self)

Returns a Future that gets fulfilled when cancellation (shutdown) is requested and the delay (if any) duration has been awaited.

Use Self::shutdown_signal_triggered for tasks that do not require this opt-in delay buffer duration.

The future will complete immediately if the token is already cancelled when this method is called.

Cancel safety

This method is cancel safe.

Panics

This method panics if the iternal mutex is poisoned while being used.

pub async fn shutdown_signal_triggered(&self)

Returns a Future that gets fulfilled when cancellation (shutdown) is requested.

Use Self::cancelled if you want to make sure the future only completes when the buffer delay has been awaited.

In case no delay has been configured for the parent Shutdown, this function will be equal in behaviour to Self::cancelled.

The future will complete immediately if the token is already cancelled when this method is called.

Cancel safety

This method is cancel safe.

Panics

This method panics if the iternal mutex is poisoned while being used.

pub fn spawn_task<T>(&self, task: T) -> JoinHandle<<T as Future>::Output>

where T: Future + Send + 'static, <T as Future>::Output: Send + 'static,

Returns a [crate::sync::JoinHandle] that can be awaited on to wait for the spawned task to complete. See [crate::sync::spawn] for more information.

pub fn into_spawn_task<T>(self, task: T) -> JoinHandle<<T as Future>::Output>

where T: Future + Send + 'static, <T as Future>::Output: Send + 'static,

Returns a Tokio [crate::sync::JoinHandle] that can be awaited on to wait for the spawned task (future) to complete. See [crate::sync::spawn] for more information.

In contrast to ShutdownGuard::spawn_task this method consumes the guard, ensuring the guard is dropped once the task future is fulfilled. ShutdownGuard::spawn_task: crate::ShutdownGuard::spawn_task

pub fn spawn_task_fn<F, T>(&self, task: F) -> JoinHandle<<T as Future>::Output>

where F: FnOnce(ShutdownGuard) -> T + Send + 'static, T: Future + Send + 'static, <T as Future>::Output: Send + 'static,

Returns a Tokio [crate::sync::JoinHandle] that can be awaited on to wait for the spawned task (fn) to complete. See [crate::sync::spawn] for more information.

pub fn into_spawn_task_fn<F, T>( self, task: F, ) -> JoinHandle<<T as Future>::Output>

where F: FnOnce(ShutdownGuard) -> T + Send + 'static, T: Future + Send + 'static, <T as Future>::Output: Send + 'static,

Returns a Tokio [crate::sync::JoinHandle] that can be awaited on to wait for the spawned task (fn) to complete. See [crate::sync::spawn] for more information.

In contrast to ShutdownGuard::spawn_task_fn this method consumes the guard, ensuring the guard is dropped once the task future is fulfilled. ShutdownGuard::spawn_task_fn: crate::ShutdownGuard::spawn_task_fn

pub fn downgrade(self) -> WeakShutdownGuard

Downgrades the guard to a WeakShutdownGuard, ensuring that the guard no longer prevents the Shutdown::shutdown future from completing.

pub fn clone_weak(&self) -> WeakShutdownGuard

Clones the guard as a WeakShutdownGuard, ensuring that the cloned guard does not prevent the Shutdown::shutdown future from completing.

Trait Implementations

impl Clone for ShutdownGuard

fn clone(&self) -> ShutdownGuard

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShutdownGuard

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

Formats the value using the given formatter.

impl Drop for ShutdownGuard

fn drop(&mut self)

Executes the destructor for this type.

impl From<WeakShutdownGuard> for ShutdownGuard

fn from(weak_guard: WeakShutdownGuard) -> ShutdownGuard

Converts to this type from the input type.