jobflow 0.3.0

Executes jobs in order
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

//! Allows for defining an action, similar to [`ActionWithState`](crate::actions::ActionWithState) via
//! a trait object.

use crate::actions::{ActionWithState, IntoAction, stateful_action};
use std::marker::PhantomData;

/// This specifies a type that can be run as part of a Job, that has no input
pub trait NoInputJob<R: Send>: Send {
    /// Runs this job
    fn execute(&mut self) -> R;
}

/// This specifies a type that can be run as part of a Job that has input
pub trait Job<T: Send, R: Send>: Send {
    /// Runs this job with the given input
    fn execute(&mut self, input: T) -> R;
}

#[doc(hidden)]
pub struct JobMarker<T, R>(PhantomData<(T, R)>);
#[doc(hidden)]
pub struct NoInputJobMarker<R>(PhantomData<R>);

impl<T: Send + 'static, R: Send + 'static, J> IntoAction<T, R, JobMarker<T, R>> for J
where
    J: Job<T, R> + 'static,
{
    type Action = ActionWithState<J, T, R>;

    fn into_action(self) -> Self::Action {
        stateful_action(self, |state: &mut J, i: T| state.execute(i))
    }
}

impl<R: Send + 'static, J> IntoAction<(), R, NoInputJobMarker<R>> for J
where
    J: NoInputJob<R> + 'static,
{
    type Action = ActionWithState<J, (), R>;

    fn into_action(self) -> Self::Action {
        stateful_action(self, |state: &mut J| state.execute())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Flow;
    use std::sync::Arc;
    use std::sync::atomic::{AtomicBool, Ordering};

    #[test]
    fn test_job_with_flow() {
        #[derive(Debug, Default)]
        struct TestJob {
            value: Arc<AtomicBool>,
        }

        impl NoInputJob<()> for TestJob {
            fn execute(&mut self) {
                let _ =
                    self.value
                        .compare_exchange(false, true, Ordering::SeqCst, Ordering::Relaxed);
            }
        }

        let mut flow: Flow = Flow::default();
        let test = TestJob::default();
        let value = test.value.clone();
        let t = flow.create("test", test);
        flow.run().unwrap();
        assert!(
            value.load(Ordering::SeqCst),
            "should have run and set the value"
        );
    }
}