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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
//! Task references: names of tasks that the compiler checks.
//!
//! A task named by a string is only checked at run time, so a typo or a stale
//! name after a rename fails when the workflow runs. The `#[task]` macro
//! generates a reference for each task, so a misspelled or stale name is a
//! compile error:
//!
//! ```rust
//! use orcher_sdk::prelude::*;
//!
//! #[derive(Serialize, Deserialize)]
//! pub struct Email {
//! to: String,
//! }
//!
//! #[task(timeout = 30)]
//! pub async fn send_email(_ctx: TaskContext, email: Email) -> Result<String> {
//! Ok(format!("sent to {}", email.to))
//! }
//!
//! // The macro also generates a constant with the task's name:
//! // pub const send_email: send_email_task_ref = send_email_task_ref;
//!
//! #[workflow]
//! async fn order_workflow(ctx: WorkflowContext, email: Email) -> Result<String> {
//! let receipt: String = ctx.execute_task(send_email, email).await?;
//! // ^^^^^^^^^^
//! // Checked at compile time.
//!
//! // Misspelled; this would compile and fail only when the workflow runs:
//! // ctx.execute_task("send_emial", email).await?;
//! Ok(receipt)
//! }
//! ```
//!
//! A reference is a zero-sized value that resolves to a `&'static str`, so it
//! costs nothing at run time.
//!
//! ## Generated code
//!
//! For a task function, `#[task]` generates code of this shape:
//!
//! ```text
//! // Written:
//! #[task]
//! pub async fn process_payment(ctx: TaskContext, amount: i64) -> Result<Receipt> {
//! // ...
//! }
//!
//! // Generated (plus a payload-level handler and its registration):
//! pub async fn process_payment_impl(ctx: TaskContext, amount: i64) -> Result<Receipt> {
//! // ...
//! }
//!
//! #[derive(Debug, Clone, Copy)]
//! #[allow(non_camel_case_types)]
//! pub struct process_payment_task_ref;
//!
//! impl ::orcher_sdk::task::TaskReference for process_payment_task_ref {
//! fn task_name(&self) -> &'static str {
//! "process_payment"
//! }
//! }
//!
//! // The function was renamed, so the task's own name is free for the reference.
//! #[allow(non_upper_case_globals)]
//! pub const process_payment: process_payment_task_ref = process_payment_task_ref;
//! ```
use fmt;
/// A compile-time checked reference to a task.
///
/// The `#[task]` and `#[tasks]` macros implement this trait on generated
/// zero-sized types. The trait is not sealed, so it can be implemented by hand,
/// but then nothing checks that the name matches a registered task.
///
/// ## Examples
///
/// ```rust
/// use orcher_sdk::prelude::*;
///
/// #[task]
/// async fn send_email(_ctx: TaskContext, email: String) -> Result<String> {
/// Ok(format!("sent to {email}"))
/// }
///
/// #[workflow]
/// async fn my_workflow(ctx: WorkflowContext, email: String) -> Result<String> {
/// // The task is named by its reference, not a string.
/// ctx.execute_task(send_email, email).await
/// }
/// ```
/// Anything that names a task: a [`TaskReference`] or a `&'static str`.
///
/// APIs that take a task accept either form. A string name is checked only at
/// run time. The trait is sealed and cannot be implemented outside this crate.
///
/// ## Examples
///
/// ```rust
/// use orcher_sdk::prelude::*;
/// use orcher_sdk::task::IntoTaskName;
///
/// #[task]
/// async fn send_email(_ctx: TaskContext, email: String) -> Result<String> {
/// Ok(email)
/// }
///
/// // Accepts a task reference or a string name, like `WorkflowContext::execute_task`.
/// fn task_label<T: IntoTaskName>(task: T) -> String {
/// format!("task:{}", task.into_task_name())
/// }
///
/// assert_eq!(task_label(send_email), "task:send_email"); // Checked at compile time
/// assert_eq!(task_label("send_email"), "task:send_email"); // Checked at run time
/// ```
// String names are accepted for callers without a task reference in scope.
// Keeps `IntoTaskName` sealed: `private::Sealed` cannot be named outside this crate.