Struct ExecCancel 

pub struct ExecCancel { /* private fields */ }

Shared cancellation signal for one executing query.

Construct with ExecCancel::with_deadline (server path) or ExecCancel::new (never auto-cancels; useful for explicit cancel only). The async side keeps a clone and calls ExecCancel::cancel; the executor thread reads it through the installed thread-local via CancelCheck.

Implementations

impl ExecCancel

pub fn new() -> Self

A token with no deadline. Only an explicit ExecCancel::cancel trips it.

pub fn with_deadline(deadline: Instant, timeout_ms: u64) -> Self

A token that trips itself once deadline passes. timeout_ms is the configured timeout used to render the timeout error message.

pub fn cancel(&self, reason: CancelReason)

Explicitly cancel for reason. Idempotent; the first reason to win stands. Safe to call from any thread.

pub fn is_cancelled(&self) -> bool

Whether the query should stop: explicitly cancelled, or past its deadline.

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

The cancellation reason, or None if the query may continue. An explicit cancel wins; otherwise a passed deadline reports Timeout.

Trait Implementations

impl Debug for ExecCancel

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

Formats the value using the given formatter.

impl Default for ExecCancel

fn default() -> Self

Returns the “default value” for a type.