Struct CancelToken 

pub struct CancelToken<'a> { /* private fields */ }

Implementations

impl<'a> CancelToken<'a>

pub const fn none() -> Self

pub const fn from_flag(f: &'a AtomicBool) -> Self

pub const fn with_deadline( self, now_fn: MonotonicNowFn, deadline_us: u64, ) -> Self

v7.17.0 Phase 2.3 — attach a monotonic deadline. now_fn must return microseconds since a stable origin; the token trips when now_fn() >= deadline_us. Compose with from_flag(...) when both a watchdog flag and a per-statement timeout are in play (e.g. server-wide SPG_QUERY_TIMEOUT_MS plus session statement_timeout); the tighter of the two wins by virtue of either signaling first.

pub fn is_cancelled(self) -> bool

pub fn check(self) -> Result<(), EngineError>

Returns Err(Cancelled) if the token has been tripped. Used at row-loop checkpoints to bail cooperatively without scattering raw is_cancelled checks across the executor.

Trait Implementations

impl<'a> Clone for CancelToken<'a>

fn clone(&self) -> CancelToken<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CancelToken<'a>

impl<'a> Debug for CancelToken<'a>

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

Formats the value using the given formatter.