Struct ShutdownToken 

pub struct ShutdownToken { /* private fields */ }

A cancellation token with a typed ShutdownReason.

Clone-to-share; every clone observes the same cancellation.

Implementations

impl ShutdownToken

pub fn new() -> Self

Construct a fresh, uncancelled token.

pub fn is_cancelled(&self) -> bool

Non-blocking check.

pub async fn cancelled(&self)

Awaitable trigger; completes as soon as any clone calls .cancel.

pub fn cancel(&self, reason: ShutdownReason)

Trigger shutdown. Idempotent — only the first call records its reason; later calls are no-ops.

pub fn reason(&self) -> Option<ShutdownReason>

Read the first-recorded reason, if any.

pub fn child_token(&self) -> ShutdownToken

Construct a child token that inherits cancellation from self.

Cancelling the child does NOT cancel the parent. Useful when a subsystem wants to shut its own subtasks down without affecting the outer service.

Trait Implementations

impl Clone for ShutdownToken

fn clone(&self) -> ShutdownToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownToken

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

Formats the value using the given formatter.

impl Default for ShutdownToken

fn default() -> Self

Returns the “default value” for a type.