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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
use Context as AnyhowCxt;
use DeserializeOwned;
use Deref;
use crateExtractionError;
use crateState;
use crateSystem;
use crate;
/// Extracts the target state for tasks created from the job handler
///
/// Allows the Job to see the desired state for the path assigned to the task.
///
/// # Example
///
/// ```rust,no_run
/// use mahler::{
/// state::State,
/// extract::Target,
/// task::{Handler, update},
/// worker::{Worker, Ready}
/// };
///
/// #[derive(State)]
/// struct MySystem {/* ... */};
///
/// fn with_target(Target(tgt): Target<i32>) {
/// // ...
/// }
///
/// let worker = Worker::new()
/// .job("/{foo}/{bar}", update(with_target))
/// .initial_state(MySystem {/* ... */})
/// .unwrap();
/// ```
///
/// Note that for non-primitive types, this extractor requires that the type implements
/// [State](`crate::state::State`)
///
/// ```rust,no_run
/// use mahler::{
/// state::{State, List},
/// extract::Target,
/// task::{Handler, update},
/// worker::Worker
/// };
///
/// #[derive(State)]
/// struct Service {
/// name: String,
/// };
///
/// #[derive(State)]
/// struct App {
/// services: List<Service>,
/// }
///
/// // Service needs to implement State to use the target extractor
/// fn with_target(Target(tgt): Target<Service>) {
/// // ...
/// }
///
/// let worker = Worker::new()
/// .job("/{foo}/{bar}", update(with_target))
/// .initial_state(App {services: List::new()})
/// .unwrap();
/// ```
///
/// # Errors
///
/// Initializing the extractor will fail if the target value for the task cannot be deserialized
/// into the given type `<T>`. This includes the case where no target exists, for instance, for
/// `delete` type jobs.
///
/// ```rust,no_run
/// use mahler::{
/// state::State,
/// extract::Target,
/// task::{Handler, delete},
/// worker::{Worker, Ready}
/// };
///
/// #[derive(State)]
/// struct SystemState {/* ... */};
///
/// // this task is applicable to `delete` operations which do not
/// // have a target, thus this extractor will always fail to be initialized
/// fn invalid_task(Target(tgt): Target<i32>) {
/// // ...
/// }
///
/// let worker: Worker<SystemState, Ready> = Worker::new()
/// // `invalid_task` will be called if a delete operation on path `/{foo}/{bar}`
/// // is required
/// .job("/{foo}/{bar}", delete(invalid_task))
/// .initial_state(SystemState {/* ... */})
/// .unwrap();
/// ```
;
/// Extracts the target state for tasks created from the job handler
///
/// Allows the Job to see the desired state for the path assigned to the task.
///
/// Note that unlike [`crate::extract::Target`], this extractor doesn't require the inner type
/// to implement `State`, only `Deserialize`
///
/// # Example
///
/// ```rust,no_run
/// use mahler::{
/// state::State,
/// extract::RawTarget,
/// task::{Handler, update},
/// worker::{Worker, Ready}
/// };
/// use serde::Deserialize;
///
/// #[derive(State)]
/// struct SystemState {/* ... */};
///
/// #[derive(Deserialize)]
/// struct Num(i32);
///
/// // MyApp does not need to implement `State`
/// fn with_target(RawTarget(tgt): RawTarget<Num>) {
/// // ...
/// }
///
/// let worker: Worker<SystemState, Ready> = Worker::new()
/// .job("/{foo}/{bar}", update(with_target))
/// .initial_state(SystemState {/* ... */})
/// .unwrap();
/// ```
;