Struct ShutdownSignal 

pub struct ShutdownSignal { /* private fields */ }

Cooperative shutdown signal handed to a plugin’s background work.

A plugin that maintains derived state generally wants a worker: something that drains the hook bus, re-embeds changed notes, compacts an index. That work outlives any single tool call, so it needs a way to learn the host is going away — otherwise a detached task keeps running against state that is being torn down, and the process cannot exit cleanly.

Cheap to clone; every clone observes the same signal.

Implementations

impl ShutdownSignal

pub fn is_shutting_down(&self) -> bool

Whether shutdown has already been requested.

Check this at the top of a work loop; use Self::cancelled to wait.

pub async fn cancelled(&self)

Resolve when shutdown is requested, immediately if it already was.

Select on this alongside the work a loop would otherwise block on:

loop {
    tokio::select! {
        _ = shutdown.cancelled() => break,
        event = events.recv() => { /* ... */ }
    }
}

Trait Implementations

impl Clone for ShutdownSignal

fn clone(&self) -> ShutdownSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownSignal

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

Formats the value using the given formatter.