Struct CancelToken 

pub struct CancelToken { /* private fields */ }

Cancellation signal shared between caller and Lua thread.

Clone is cheap (Arc).

Two cancellation pathways are wired:

1. A Lua debug hook polls is_cancelled every N Lua instructions. This interrupts pure-Lua CPU-bound loops (while true do end etc).

2. When the feature tokio is enabled, cancelled provides an async signal that fires as soon as cancel is called. Coroutine executors (execute_coroutine_eval, execute_coroutine_call) use this in a tokio::select! to drop the in-flight Lua coroutine even when the coroutine is suspended inside a Rust .await (e.g. a create_async_function awaiting a tokio child process). The debug hook alone cannot interrupt such Rust-suspended coroutines because no Lua instructions execute during the .await, so the hook never fires.

Implementations

impl CancelToken

pub fn new() -> Self

Create a new token (not cancelled).

pub fn cancel(&self)

Signal cancellation.

Sets the atomic flag (observed by the Lua debug hook) and, when the tokio feature is enabled, notifies all waiters of the async cancelled signal.

pub fn is_cancelled(&self) -> bool

Check whether cancellation has been requested.

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> CancelToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CancelToken

fn default() -> Self

Returns the “default value” for a type.