qubit-executor 0.5.0

Executor abstractions, task handles, and basic executor implementations 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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
/// Runnable closure produced after a scheduled task wins the start race.
pub(crate) type StartedScheduledTask = Box<dyn FnOnce() + Send + 'static>;

/// Type-erased scheduled task stored in the timer heap.
pub(crate) trait ScheduledTaskEntry: Send + 'static {
    /// Marks this task as accepted by the scheduled service.
    fn accept(&self);

    /// Returns whether this task has already been cancelled before start.
    fn is_cancelled(&self) -> bool;

    /// Attempts to move this task from pending to running state.
    ///
    /// # Returns
    ///
    /// A runnable closure if the task should execute, or `None` if it had already
    /// been cancelled before start.
    fn start(self: Box<Self>) -> Option<StartedScheduledTask>;

    /// Cancels this task before it starts.
    ///
    /// # Returns
    ///
    /// `true` if this call published task cancellation.
    fn cancel(self: Box<Self>) -> bool;
}