Skip to main content

CancelToken

Struct CancelToken 

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

v4.5 cooperative cancellation token. A long-running SELECT / UPDATE / DELETE checks is_cancelled at row-loop checkpoints and bails with EngineError::Cancelled. The host (spg-server) creates an AtomicBool per query, spawns a watchdog thread that sets it after SPG_QUERY_TIMEOUT_MS, and passes it via execute_with_cancel / execute_readonly_with_cancel.

CancelToken::none() is a no-op — used by the legacy execute and execute_readonly entry points so existing callers don’t change.

Implementations§

Source§

impl<'a> CancelToken<'a>

Source

pub const fn none() -> Self

Source

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

Source

pub fn is_cancelled(self) -> bool

Source

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§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for CancelToken<'a>

§

impl<'a> RefUnwindSafe for CancelToken<'a>

§

impl<'a> Send for CancelToken<'a>

§

impl<'a> Sync for CancelToken<'a>

§

impl<'a> Unpin for CancelToken<'a>

§

impl<'a> UnsafeUnpin for CancelToken<'a>

§

impl<'a> UnwindSafe for CancelToken<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.