qubit-executor 0.1.1

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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026.
 *    Haixing Hu, Qubit Co. Ltd.
 *
 *    All rights reserved.
 *
 ******************************************************************************/
use std::{
    error::Error,
    fmt,
};

/// Result type used by managed task handles.
pub type TaskResult<R, E> = Result<R, TaskExecutionError<E>>;

/// Error observed when retrieving the result of an accepted task.
///
/// This error is distinct from [`RejectedExecution`](crate::service::RejectedExecution).
/// Rejection happens before a service accepts a task; `TaskExecutionError`
/// describes what happened after the task was accepted.
///
/// # Type Parameters
///
/// * `E` - The error type returned by the task itself.
///
/// # Author
///
/// Haixing Hu
#[derive(Debug)]
pub enum TaskExecutionError<E> {
    /// The task ran and returned `Err(E)`.
    Failed(E),

    /// The task panicked while running.
    Panicked,

    /// The task was cancelled before producing a result.
    Cancelled,
}

impl<E> TaskExecutionError<E> {
    /// Returns true when this error wraps the task's own error value.
    ///
    /// # Returns
    ///
    /// `true` if the task returned `Err(E)`.
    #[inline]
    pub const fn is_failed(&self) -> bool {
        matches!(self, Self::Failed(_))
    }

    /// Returns true when the task panicked.
    ///
    /// # Returns
    ///
    /// `true` if the task panicked while running.
    #[inline]
    pub const fn is_panicked(&self) -> bool {
        matches!(self, Self::Panicked)
    }

    /// Returns true when the task was cancelled.
    ///
    /// # Returns
    ///
    /// `true` if the task was cancelled before producing a result.
    #[inline]
    pub const fn is_cancelled(&self) -> bool {
        matches!(self, Self::Cancelled)
    }
}

impl<E> fmt::Display for TaskExecutionError<E>
where
    E: fmt::Display,
{
    /// Formats this task execution error for users.
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Failed(err) => write!(f, "task failed: {err}"),
            Self::Panicked => f.write_str("task panicked"),
            Self::Cancelled => f.write_str("task was cancelled"),
        }
    }
}

impl<E> Error for TaskExecutionError<E> where E: Error + 'static {}