qubit-executor 0.3.3

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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/

/// Lifecycle state for a managed executor service.
///
/// The lifecycle is an admission and termination state machine shared by
/// [`ExecutorService`](super::ExecutorService) implementations:
///
/// * [`Running`](Self::Running) accepts new tasks.
/// * [`ShuttingDown`](Self::ShuttingDown) is entered by
///   [`ExecutorService::shutdown`](super::ExecutorService::shutdown). It
///   rejects new tasks but lets already accepted work finish normally.
/// * [`Stopping`](Self::Stopping) is entered by
///   [`ExecutorService::stop`](super::ExecutorService::stop). It rejects new
///   tasks and asks the implementation to cancel or abort accepted work that
///   can still be stopped.
/// * [`Terminated`](Self::Terminated) means shutdown or stop has been requested
///   and no accepted work remains active.
///
/// `ShuttingDown` and `Stopping` are both non-running states. The distinction is
/// what happens to accepted work: orderly shutdown preserves accepted work,
/// while abrupt stop is a best-effort cancellation or abort request. Already
/// running blocking code or OS threads may not be forcibly stopped; concrete
/// services document those runtime-specific limits.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ExecutorServiceLifecycle {
    /// The service accepts new tasks and may have accepted work in progress.
    Running = 0,

    /// Graceful shutdown has started.
    ///
    /// The service rejects new submissions, but work accepted before
    /// [`ExecutorService::shutdown`](super::ExecutorService::shutdown) is
    /// allowed to finish normally.
    ShuttingDown = 1,

    /// Abrupt stop has started.
    ///
    /// The service rejects new submissions and is cancelling or aborting
    /// accepted work it can still stop. Work that is already running in a form
    /// the runtime cannot interrupt may continue until that work returns.
    Stopping = 2,

    /// The service no longer accepts tasks and has no accepted work in progress.
    ///
    /// This state is reached only after shutdown or stop has been requested and
    /// all accepted work has completed, been cancelled, been dropped by its
    /// runner endpoint, or been aborted.
    Terminated = 3,
}