batch-processing 0.1.17

A batch library for processing a list of items in parallel
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use crate::sync::step::{DeciderCallback, SyncStep, StepCallback};
use crate::sync::step::step_builder::StepBuilderTrait;

/// A trait for building simple synchronous steps.
pub trait SimpleStepBuilderTrait<I, O> {
    /// Configures the step with a tasklet callback.
    ///
    /// # Arguments
    ///
    /// * `step_callback` - The tasklet callback function.
    ///
    /// # Returns
    ///
    /// Returns a modified builder instance.
    fn tasklet(self, step_callback: StepCallback) -> Self;
}

/// A builder struct for constructing simple synchronous steps.
pub struct SimpleStepBuilder {
    /// The step being constructed.
    step: SyncStep,
}

impl StepBuilderTrait for SimpleStepBuilder {
    /// Sets the decider callback for the step.
    ///
    /// # Arguments
    ///
    /// * `decider` - The decider callback function.
    ///
    /// # Returns
    ///
    /// Returns a modified builder instance.
    fn decider(self, decider: DeciderCallback) -> Self {
        SimpleStepBuilder {
            step: SyncStep {
                decider: Some(decider),
                ..self.step
            }
        }
    }

    /// Configures the step to be tolerant to thrown exceptions.
    ///
    /// # Returns
    ///
    /// Returns a modified builder instance.
    fn throw_tolerant(self) -> Self {
        SimpleStepBuilder {
            step: SyncStep {
                throw_tolerant: Some(true),
                ..self.step
            }
        }
    }

    /// Initializes a new builder instance with the given name.
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the step.
    ///
    /// # Returns
    ///
    /// Returns a new builder instance.
    #[inline]
    fn get(name: String) -> Self {
        SimpleStepBuilder {
            step: SyncStep {
                name,
                callback: None,
                decider: None,
                end_time: None,
                start_time: None,
                throw_tolerant: None,
            }
        }
    }

    /// Validates the builder configuration.
    ///
    /// # Returns
    ///
    /// Returns a modified builder instance if validation succeeds.
    fn validate(self) -> Self {
        if self.step.callback.is_none() {
            panic!("Tasklet is required");
        }

        if self.step.name.is_empty() {
            panic!("Name is required");
        }

        return self;
    }

    /// Builds and returns the configured synchronous step.
    ///
    /// # Returns
    ///
    /// Returns the configured synchronous step.
    fn build(self) -> SyncStep {
        let current_self = self.validate();
        return current_self.step;
    }
}

impl SimpleStepBuilderTrait<fn(), fn()> for SimpleStepBuilder {
    /// Configures the step with a tasklet callback.
    ///
    /// # Arguments
    ///
    /// * `step_callback` - The tasklet callback function.
    ///
    /// # Returns
    ///
    /// Returns a modified builder instance.
    fn tasklet(self, step_callback: StepCallback) -> Self {
        return SimpleStepBuilder {
            step: SyncStep {
                callback: Some(step_callback),
                ..self.step
            }
        };
    }
}

/// Initializes a new simple step builder with the given name.
///
/// # Arguments
///
/// * `name` - The name of the step.
///
/// # Returns
///
/// Returns a new simple step builder instance.
pub fn get(name: String) -> SimpleStepBuilder {
    SimpleStepBuilder::get(name)
}