Struct FfiCancellationToken 

pub struct FfiCancellationToken { /* private fields */ }

FFI-safe cancellation token.

This token holds a reference to the shared cancellation state. It must be explicitly destroyed with enough_token_destroy.

The token remains valid even after the source is destroyed - it will just never become cancelled.

Implementations

impl FfiCancellationToken

pub fn never() -> Self

Create a “never cancelled” token.

This token will never report as cancelled.

pub unsafe fn from_ptr( ptr: *const FfiCancellationToken, ) -> FfiCancellationTokenView

Create a token view from a raw pointer.

This creates a non-owning view that can be used to check cancellation. The original token must remain valid for the lifetime of this view.

Safety

• If ptr is non-null, it must point to a valid FfiCancellationToken
• The pointed-to token must outlive all uses of the returned view

Trait Implementations

impl Debug for FfiCancellationToken

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

Formats the value using the given formatter.

impl Stop for FfiCancellationToken

fn check(&self) -> Result<(), StopReason>

Check if the operation should stop.

fn should_stop(&self) -> bool

Returns true if the operation should stop.