qubit-batch 0.3.1

Batch task execution abstractions and sequential executor with progress reporting
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
89
90
91
92
93
94
95
96
97
98
99
100

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

/// Result produced by [`crate::BatchExecutor::call`].
///
/// The execution result contains the same failure aggregation as
/// [`crate::BatchExecutor::execute`]. The value list is indexed by the original
/// callable index; successful callables store `Some(value)`, while failed or
/// panicked callables store `None`.
///
/// # Type Parameters
///
/// * `R` - Callable success value type.
/// * `E` - Callable error type.
///
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BatchCallResult<R, E> {
    /// Execution summary and failures for the callable batch.
    execution_result: BatchExecutionResult<E>,
    /// Success values indexed by callable position.
    values: Vec<Option<R>>,
}

impl<R, E> BatchCallResult<R, E> {
    /// Creates a new callable batch result.
    ///
    /// # Parameters
    ///
    /// * `execution_result` - Execution summary and failures.
    /// * `values` - Success values indexed by callable position.
    ///
    /// # Returns
    ///
    /// A callable batch result.
    #[inline]
    pub fn new(execution_result: BatchExecutionResult<E>, values: Vec<Option<R>>) -> Self {
        Self {
            execution_result,
            values,
        }
    }

    /// Returns the execution summary for the callable batch.
    ///
    /// # Returns
    ///
    /// A shared reference to the underlying execution result.
    #[inline]
    pub const fn execution_result(&self) -> &BatchExecutionResult<E> {
        &self.execution_result
    }

    /// Returns success values indexed by callable position.
    ///
    /// # Returns
    ///
    /// A shared slice of optional success values.
    #[inline]
    pub fn values(&self) -> &[Option<R>] {
        self.values.as_slice()
    }

    /// Consumes this result and returns the execution summary.
    ///
    /// # Returns
    ///
    /// The underlying execution result.
    #[inline]
    pub fn into_execution_result(self) -> BatchExecutionResult<E> {
        self.execution_result
    }

    /// Consumes this result and returns success values.
    ///
    /// # Returns
    ///
    /// Success values indexed by callable position.
    #[inline]
    pub fn into_values(self) -> Vec<Option<R>> {
        self.values
    }

    /// Consumes this result and returns both stored parts.
    ///
    /// # Returns
    ///
    /// A tuple containing the execution result and indexed success values.
    #[inline]
    pub fn into_parts(self) -> (BatchExecutionResult<E>, Vec<Option<R>>) {
        (self.execution_result, self.values)
    }
}