Struct ExecutionCancellation 

pub struct ExecutionCancellation { /* private fields */ }

Shared cooperative cancellation token for native query execution.

Cancellation is observed only at native-engine boundaries. It does not preempt a libcudf/CUDA call already in flight, but it prevents the next source chunk, pipeline task, operator, or materialization step from starting once it is requested. A wait can also resolve on it through Self::cancelled_or_expired.

Implementations

impl ExecutionCancellation

pub fn new() -> Self

Creates a non-cancelled execution flag.

pub fn with_deadline(deadline: Option<Instant>) -> Self

Creates a cancellation token with an optional absolute deadline.

The deadline is checked at the same cooperative native-engine boundaries as caller cancellation. It cannot preempt a CUDA call already in flight, but it prevents the next safe boundary from starting more native work after the deadline has elapsed.

pub fn cancel(&self)

Marks the execution as cancelled and wakes every Self::cancelled_or_expired waiter.

pub async fn cancelled_or_expired(&self)

Resolves once the execution is cancelled or its deadline elapses, so a wait with no other wakeup for either can race it. Self::check still tells the two apart. Must run inside a Tokio runtime with the time driver enabled when a deadline is set.

pub async fn terminated(&self, operation: &'static str) -> QueryError

Resolves to the typed error that ends a wait: the cancellation, or the deadline once it elapses. A waiter returns it directly and does not read the clock again, since a paused Tokio clock can disagree with a fresh reading.

pub fn sleep(&self, duration: Duration, operation: &'static str) -> Result<()>

Blocks the calling thread for duration. Cancellation or an elapsed deadline ends the wait early with the typed error Self::check reports.

pub fn is_cancelled(&self) -> bool

Returns whether this execution must stop at its next cooperative safe boundary.

An elapsed deadline is intentionally an effective cancellation here. Callers that need to distinguish an explicit caller action from expiry must use Self::check, which preserves explicit cancellation as the primary reason.

pub fn deadline(&self) -> Option<Instant>

Returns the optional absolute deadline shared by every clone.

pub fn is_expired(&self) -> bool

Returns whether the optional deadline has elapsed.

pub fn check(&self, operation: &'static str) -> Result<()>

Returns a structured native error if cancellation has been requested or the deadline has elapsed. Explicit cancellation takes precedence over expiry.

Trait Implementations

impl Clone for ExecutionCancellation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionCancellation

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

Formats the value using the given formatter.

impl Default for ExecutionCancellation

fn default() -> Self

Returns the “default value” for a type.