qubit-thread-pool 0.3.0

Dynamic and fixed thread pool executor services for Qubit Rust libraries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
use std::sync::atomic::{
    AtomicU8,
    Ordering,
};

/// Atomic task-state transitions for delayed task scheduling.
pub struct DelayedTaskState;

impl DelayedTaskState {
    /// Task has been accepted but has not started.
    pub const PENDING: u8 = 0;
    /// Task has started and can no longer be cancelled.
    pub const STARTED: u8 = 1;
    /// Task was cancelled before it started.
    pub const CANCELLED: u8 = 2;

    /// Attempts to mark a task state as cancelled.
    pub fn cancel(task_state: &AtomicU8) -> bool {
        task_state
            .compare_exchange(
                Self::PENDING,
                Self::CANCELLED,
                Ordering::AcqRel,
                Ordering::Acquire,
            )
            .is_ok()
    }

    /// Attempts to mark a task state as started.
    pub fn start(task_state: &AtomicU8) -> bool {
        task_state
            .compare_exchange(
                Self::PENDING,
                Self::STARTED,
                Ordering::AcqRel,
                Ordering::Acquire,
            )
            .is_ok()
    }

    /// Returns whether a task state has been cancelled.
    pub fn is_cancelled(task_state: &AtomicU8) -> bool {
        task_state.load(Ordering::Acquire) == Self::CANCELLED
    }
}

pub const TASK_PENDING: u8 = DelayedTaskState::PENDING;
pub const TASK_CANCELLED: u8 = DelayedTaskState::CANCELLED;

/// Attempts to mark a task state as cancelled.
pub fn cancel_task_state(task_state: &AtomicU8) -> bool {
    DelayedTaskState::cancel(task_state)
}

/// Attempts to mark a task state as started.
pub fn start_task_state(task_state: &AtomicU8) -> bool {
    DelayedTaskState::start(task_state)
}

/// Returns whether a task state has been cancelled.
pub fn is_task_cancelled(task_state: &AtomicU8) -> bool {
    DelayedTaskState::is_cancelled(task_state)
}