Skip to main content

CancelToken

Struct CancelToken 

Source
pub struct CancelToken { /* private fields */ }
Expand description

Cancellation signal shared between caller and Lua thread.

Clone is cheap (Arc).

Two cancellation pathways are wired:

  1. A Lua debug hook checks is_cancelled every N Lua instructions. This interrupts pure-Lua CPU-bound loops (while true do end etc), including loops inside coroutines that the Lua code itself creates.

  2. When the feature tokio is enabled, cancelled provides an async signal that fires as soon as cancel is called. Coroutine executors use it to stop a Lua coroutine even when it is suspended inside a Rust .await (e.g. a create_async_function awaiting a tokio child process), a state in which the debug hook cannot fire because no Lua instructions execute.

§Hierarchy

child_token derives a token that is cancelled whenever its parent is. A parent holds its children weakly and a child holds its parent strongly: a finished child disappears from its parent without an explicit unregister, and a live grandchild keeps the chain between it and the root alive.

Implementations§

Source§

impl CancelToken

Source

pub fn new() -> Self

Create a new token (not cancelled).

Source

pub fn child_token(&self) -> CancelToken

Derive a child token.

The child is cancelled when this token is cancelled (at once if it already is). Cancelling the child does not affect this token.

Source

pub fn cancel(&self)

Signal cancellation.

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

Source

pub fn is_cancelled(&self) -> bool

Check whether cancellation has been requested.

Trait Implementations§

Source§

impl Clone for CancelToken

Source§

fn clone(&self) -> Self

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 Debug for CancelToken

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CancelToken

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T

Source§

impl<T> MaybeSync for T

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.