Struct ProcessShutdown 

pub struct ProcessShutdown { /* private fields */ }

A shutdown signal for a process.

This struct can be used to wait for a shutdown signal from the supervisor to which the process belongs.

Implementations

impl ProcessShutdown

pub fn paired() -> (Self, ShutdownHandle)

Creates a new ProcessShutdown and ShutdownHandle pair.

When ShutdownHandle is triggered, or dropped, ProcessShutdown will resolve.

pub fn wrapped<F: Future + Send + 'static>(future: F) -> Self

Creates a new ProcessShutdown from the given future.

ProcessShutdown will be resolve only once future resolves.

pub fn noop() -> Self

Creates a new ProcessShutdown that never resolves.

This is useful for cases where a ProcessShutdown is required, but no shutdown signal is expected.

pub async fn wait_for_shutdown(&mut self)

Waits for the shutdown signal to be received.

If the shutdown signal has been received during a previous call to this function, this function will return immediately for all subsequent calls.

ProcessShutdown also implements Future directly, which can be useful when passing it to APIs that accept a generic future (e.g., as a shutdown signal parameter).

Trait Implementations

impl Future for ProcessShutdown

Implements Future for direct use in select! or as a generic shutdown signal.

This is equivalent to calling ProcessShutdown::wait_for_shutdown — once the shutdown signal is received (or has been received previously), the future resolves immediately.

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.