beekeeper 0.3.0

A full-featured worker pool library for parallelizing tasks
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
101
102
103
104
105
106
107
108
109

mod batch;
mod r#impl;
mod iter;
mod queue;
mod store;

pub use self::batch::OutcomeBatch;
pub use self::iter::OutcomeIteratorExt;
pub use self::queue::OutcomeQueue;
pub use self::store::OutcomeStore;

pub(super) use self::store::{DerefOutcomes, OwnedOutcomes};

use crate::bee::{TaskId, Worker};
use crate::panic::Panic;
use derive_more::Debug;

/// The possible outcomes of a task execution.
///
/// Each outcome includes the task ID of the task that produced it. Tasks that submitted
/// subtasks (via [`crate::bee::Context::submit`]) produce `Outcome` variants that have
/// `subtask_ids`.
///
/// Note that `Outcome`s can only be compared or ordered with other `Outcome`s produced by the same
/// `Hive`, because comparison/ordering is completely based on the task ID.
#[derive(Debug)]
pub enum Outcome<W: Worker> {
    /// The task was executed successfully.
    Success {
        #[debug(skip)]
        value: W::Output,
        task_id: TaskId,
    },
    /// The task was executed successfully, and it also submitted one or more subtask_ids to the
    /// `Hive`.
    SuccessWithSubtasks {
        #[debug(skip)]
        value: W::Output,
        task_id: TaskId,
        subtask_ids: Vec<TaskId>,
    },
    /// The task failed with an error that was not retryable. The input value that caused the
    /// failure is provided if possible.
    Failure {
        #[debug(skip)]
        input: Option<W::Input>,
        error: W::Error,
        task_id: TaskId,
    },
    /// The task failed with an error that was not retryable, but it submitted one or more subtask_ids
    /// before failing. The input value that caused the failure is provided if possible.
    FailureWithSubtasks {
        #[debug(skip)]
        input: Option<W::Input>,
        error: W::Error,
        task_id: TaskId,
        subtask_ids: Vec<TaskId>,
    },
    /// The task was not executed before the Hive was dropped, or processing of the task was
    /// interrupted (e.g., by `suspend`ing the `Hive`).
    Unprocessed {
        #[debug(skip)]
        input: W::Input,
        task_id: TaskId,
    },
    /// The task was not executed before the Hive was dropped, or processing of the task was
    /// interrupted (e.g., by `suspend`ing the `Hive`), but it first submitted one or more subtask_ids.
    UnprocessedWithSubtasks {
        #[debug(skip)]
        input: W::Input,
        task_id: TaskId,
        subtask_ids: Vec<TaskId>,
    },
    /// The task with the given task_id was not found in the `Hive` or iterator from which it was
    /// being requested.
    Missing { task_id: TaskId },
    /// The task panicked. The input value that caused the panic is provided if possible.
    Panic {
        #[debug(skip)]
        input: Option<W::Input>,
        payload: Panic<String>,
        task_id: TaskId,
    },
    /// The task panicked, but it submitted one or more subtask_ids before panicking. The input value
    /// that caused the panic is provided if possible.
    PanicWithSubtasks {
        #[debug(skip)]
        input: Option<W::Input>,
        payload: Panic<String>,
        task_id: TaskId,
        subtask_ids: Vec<TaskId>,
    },
    /// The task's weight was larger than the configured limit for the `Hive`.
    #[cfg(feature = "local-batch")]
    WeightLimitExceeded {
        #[debug(skip)]
        input: W::Input,
        weight: u32,
        task_id: TaskId,
    },
    /// The task failed after retrying the maximum number of times.
    #[cfg(feature = "retry")]
    MaxRetriesAttempted {
        #[debug(skip)]
        input: W::Input,
        error: W::Error,
        task_id: TaskId,
    },
}