Struct StopToken 

pub struct StopToken { /* private fields */ }

Read-only handle to a thread’s cooperative-cancellation flag.

Cheap to copy, Send + Sync. Reads the per-thread atomic flag set by JoinHandle::request_stop (or implicitly by JoinHandle’s Drop).

Workers spawned via Builder::spawn receive a StopToken as their entry argument and poll StopToken::is_stopped to break cleanly out of their loop. Tokens can be cloned and passed to helper functions that need to bail out without being handed the owning JoinHandle.

use ove::{Thread, StopToken, Priority};

let h = Thread::builder()
    .name(c"worker")
    .priority(Priority::Normal)
    .stack_size(4096)
    .spawn(|tok: StopToken| {
        while !tok.is_stopped() {
            // do work
        }
    })?;

// h goes out of scope -> Drop calls request_stop + join.

Implementations

impl StopToken

pub const fn empty() -> Self

Construct an empty token that never signals stop. Useful as a default for fields filled in later.

pub fn is_stopped(&self) -> bool

true if JoinHandle::request_stop (or the parent’s Drop) has been called on the referenced thread. Returns false for an empty token.

pub fn stop_possible(&self) -> bool

true if this token references a real thread (vs. StopToken::empty).

pub fn raw_handle(&self) -> ove_thread_t

Raw handle accessor for advanced use.

Trait Implementations

impl Clone for StopToken

fn clone(&self) -> StopToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopToken

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

Formats the value using the given formatter.

impl Copy for StopToken

impl Send for StopToken

impl Sync for StopToken