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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
#![deny(unsafe_code)]
use cfg_if::cfg_if;
use core::sync::atomic::{AtomicBool, Ordering};
use parking_lot::{Condvar, Mutex};
use std::{sync::Arc, thread};

#[derive(Clone, Debug)]
/// Simple helper thread safe state management (using Arc<(Mutex<T>, Condvar)> under the hood).
pub struct State<T> {
    item: Arc<(Mutex<T>, Condvar)>,
}

impl<T: Clone + Send + Sync + ?Sized> State<T> {
    /// Create new state.
    pub fn new(item: T) -> State<T> {
        State {
            item: Arc::new((Mutex::new(item), Condvar::new())),
        }
    }

    /// Async set state.
    pub async fn async_set(&self, item: T) {
        let (mtx, cvar) = &*self.item;
        let mut mtx = mtx.lock();
        *mtx = item;
        cvar.notify_one();
    }

    /// Async get state.
    pub async fn async_get(&self) -> T {
        let (mtx, cvar) = &*self.item;
        if mtx.is_locked() {
            let mut mtx = mtx.lock();
            cvar.wait(&mut mtx);
            mtx.clone()
        } else {
            let mtx = mtx.lock();
            mtx.clone()
        }
    }

    /// Set state.
    pub fn set(&self, item: T) {
        let (mtx, cvar) = &*self.item;
        let mut mtx = mtx.lock();
        *mtx = item;
        cvar.notify_one();
    }

    /// Get state.
    pub fn get(&self) -> T {
        let (mtx, cvar) = &*self.item;
        if mtx.is_locked() {
            let mut mtx = mtx.lock();
            cvar.wait(&mut mtx);
            mtx.clone()
        } else {
            let mtx = mtx.lock();
            mtx.clone()
        }
    }
}

#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
/// Result for returned Futurize values where T: Completed, E: Error.
pub enum Progress<T, E> {
    /// Current progress of the task
    Current,
    /// Indicates if the task is canceled
    Canceled,
    Completed(T),
    Error(E),
}

cfg_if! {
    if #[cfg(feature = "blocking")] {
        #[derive(Clone)]
        /// Futurize task asynchronously.
        pub struct Futurize<T, E> {
            id: u32,
            closure: Arc<dyn Send + Sync + Fn(Arc<AtomicBool>) -> Progress<T, E>>,
            states: Arc<(AtomicBool, AtomicBool, Mutex<Progress<T, E>>, Condvar)>,
            _cancel: Arc<AtomicBool>
        }
    } else {
        #[derive(Clone)]
        /// Futurize task asynchronously.
        /// # Example:
        ///
        ///```
        /// use asynchron::{Futurize, Progress};
        /// use std::time::{Duration, Instant};
        ///
        /// fn main() {
        ///     let instant: Instant = Instant::now();
        ///
        ///     let mut tasks = Vec::new();
        ///
        ///     for i in 0..5 {
        ///         let task = Futurize::task(i, move |cancel| -> Progress<u32, ()> {
        ///             let millis = i + 1;
        ///             let sleep_dur = Duration::from_millis((60 * millis).into());
        ///             std::thread::sleep(sleep_dur);
        ///             if cancel.load(std::sync::atomic::Ordering::Relaxed) {
        ///                 return Progress::Canceled;
        ///             } else {
        ///                 return Progress::Completed(instant.elapsed().subsec_millis());
        ///             }
        ///         });
        ///         tasks.push(task);
        ///     }
        ///
        ///     for task in tasks.iter() {
        ///         task.try_do()
        ///     }
        ///
        ///     let mut task_count = tasks.len();
        ///     loop {
        ///         for task in tasks.iter() {
        ///             if task.is_in_progress() {
        ///                 match task.try_get() {
        ///                     Progress::Current => {
        ///                         if task.task_id() == 0 || task.task_id() == 3 {
        ///                             task.cancel();
        ///                         }
        ///                         println!("task with id: {} is trying to be done\n", task.task_id());
        ///                     }
        ///                     Progress::Canceled =>  println!("task with id: {} is canceled\n", task.task_id()),
        ///                     Progress::Completed(elapsed) => {
        ///                         println!(
        ///                             "task with id: {} elapsed at: {:?} milliseconds\n",
        ///                             task.task_id(), elapsed
        ///                         );
        ///                     }
        ///                     _ => (),
        ///                 }
        ///
        ///                 if task.is_done() {
        ///                     task_count -= 1;
        ///                 }
        ///             }
        ///         }
        ///
        ///         if task_count == 0 {
        ///             println!("all the tasks are done.");
        ///             break;
        ///         }
        ///         std::thread::sleep(Duration::from_millis(50));
        ///     }
        /// }
        ///```
        pub struct Futurize<T, E> {
            id: u32,
            closure: Arc<dyn Send + Sync + Fn(Arc<AtomicBool>) -> Progress<T, E>>,
            states: Arc<(AtomicBool, AtomicBool, Mutex<Progress<T, E>>)>,
            _cancel: Arc<AtomicBool>
        }
    }
}

impl<T, E> Futurize<T, E>
where
    T: Clone + Send + 'static,
    E: Clone + Send + 'static,
{
    /// Create new task.
    /// # Other Example:
    ///
    /// ```
    /// use asynchron::{Futurize, Progress};
    /// use std::{
    ///     time::{Duration, Instant},
    /// };
    ///
    /// fn main() {
    ///     let instant1: Instant = Instant::now();
    ///     let mut task1_approx_dur = Duration::from_millis(400);
    ///
    ///     let task1 = Futurize::task(0, move |_canceled| {
    ///         std::thread::sleep(task1_approx_dur);
    ///         let elapsed_content = format!(
    ///            "instant 1 enlapsed by now {}",
    ///             instant1.elapsed().subsec_millis()
    ///         );
    ///         // for Error demo, change the line above like so: (will return error)
    ///         //
    ///         // let elapsed_content = format!("notsparatedbyspace{}", instant1.elapsed().subsec_millis());
    ///         let mut vec_ui32 = Vec::new();
    ///         elapsed_content
    ///             .split(" ")
    ///             .for_each(|ch| match ch.trim().parse::<u32>() {
    ///                 Ok(ui32) => {
    ///                     vec_ui32.push(ui32);
    ///                     // for Cancelation demo
    ///                     //
    ///                     // if canceled.load(sync::atomic::Ordering) {
    ///                     //     return Progress::Canceled;
    ///                     // }
    ///                 }
    ///                 _ => (),
    ///             });
    ///         // and this, for Cancelation at the end of the tunnel
    ///         //
    ///         // if canceled.load(sync::atomic::Ordering) {
    ///         //     return Progress::Canceled;
    ///         // }
    ///         if vec_ui32.len() > 0 {
    ///             return Progress::Completed(vec_ui32);
    ///         } else {
    ///             return Progress::Error(
    ///                 "task 1 error:
    ///                 unable to parse u32
    ///                 at asynchron/example.rs on the line 20\n"
    ///                     .to_string(),
    ///             );
    ///         }
    ///     });
    ///     task1.try_do();
    ///
    ///     let mut task2_approx_dur = Duration::from_millis(600);
    ///     let instant2: Instant = Instant::now();
    ///     let task2 = Futurize::task(1, move |_| -> Progress<u32, ()> {
    ///         std::thread::sleep(task2_approx_dur);
    ///         return Progress::Completed(instant2.elapsed().subsec_millis());
    ///     });
    ///     task2.try_do();
    ///
    ///     // let mut retry = 0;
    ///
    ///     loop {
    ///         if task1.is_in_progress() {
    ///             match task1.try_get() {
    ///                 Progress::Current => {
    ///                     println!("task 1 is trying to be done\n");
    ///                 }
    ///                 Progress::Canceled => println!("task 1 canceled"),
    ///                 Progress::Completed(value) => {
    ///                     task1_approx_dur = instant1.elapsed();
    ///                     println!(
    ///                         "task 1 completed at: {:?} has value: {:?}\n",
    ///                         task1_approx_dur, value
    ///                     );
    ///                     // task1.try_do();
    ///                     // retry += 1;
    ///                 }
    ///                 Progress::Error(e) => println!("{}", e),
    ///             }
    ///         }
    ///
    ///         // if retry == 0 {
    ///         //     task1.cancel()
    ///         // } else if retry > 1 {
    ///         //     break;
    ///         // }
    ///
    ///         if task2.is_in_progress() {
    ///             match task2.try_get() {
    ///                 Progress::Current => println!("task 2 is trying to be done\n"),
    ///                 Progress::Completed(value) => {
    ///                     task2_approx_dur = instant2.elapsed();
    ///                     println!(
    ///                         "task 2 completed at: {:?} has value: {:?}\n",
    ///                         task2_approx_dur, value
    ///                     );
    ///                     // task1.try_do();
    ///                 }
    ///                 _ => (),
    ///             }
    ///         }
    ///
    ///         if task1.is_done() && task2.is_done() {
    ///             break;
    ///         }
    ///         std::thread::sleep(Duration::from_millis(100));
    ///     }
    ///     let all_approxed_durs = task2_approx_dur + task1_approx_dur;
    ///     println!(
    ///         "all the tasks are done {:?} earlier.\n\nOk",
    ///         all_approxed_durs - task2_approx_dur
    ///     );
    /// }
    /// ```
    pub fn task<F>(id: u32, closure: F) -> Futurize<T, E>
    where
        F: Send + Sync + 'static + Fn(Arc<AtomicBool>) -> Progress<T, E>,
    {
        cfg_if! {
            if #[cfg(feature = "blocking")] {
                Futurize {
                    id,
                    closure: Arc::new(closure),
                    states: Arc::new((
                        AtomicBool::new(false),
                        AtomicBool::new(false),
                        Mutex::new(Progress::Current),
                        Condvar::new(),
                    )),
                    _cancel: Arc::new(AtomicBool::new(false))
                }
            } else {
                Futurize {
                    id,
                    closure: Arc::new(closure),
                    states: Arc::new((
                        AtomicBool::new(false),
                        AtomicBool::new(false),
                        Mutex::new(Progress::Current)
                    )),
                    _cancel: Arc::new(AtomicBool::new(false))
                }
            }
        }
    }

    /// Try (it won't block the current thread) to do the task now and then try to get the progress somewhere later on.
    #[inline]
    pub fn try_do(&self) {
        let awaiting = &self.states.0;
        if !awaiting.load(Ordering::SeqCst) {
            awaiting.store(true, Ordering::SeqCst);
            if self._cancel.load(Ordering::SeqCst) {
                self._cancel.store(false, Ordering::SeqCst)
            }
            let states = Arc::clone(&self.states);
            let cancel = Arc::clone(&self._cancel);
            let closure = Arc::clone(&self.closure);
            cfg_if! {
                if #[cfg(feature = "blocking")] {
                    thread::spawn(move || {
                        let (_, ready,mtx,cvar) = &*states;
                        let result = closure(cancel);
                        let mut mtx = mtx.lock();
                        *mtx = result;
                        ready.store(true, Ordering::Relaxed);
                        cvar.notify_one();
                    });
                } else {
                    thread::spawn(move || {
                        let (_,ready, mtx) = &*states;
                        let result = closure(cancel);
                        let mut mtx = mtx.lock();
                        *mtx = result;
                        ready.store(true, Ordering::Relaxed);
                    });
                }
            }
        }
    }

    /// Cancel the task.
    #[inline(always)]
    pub fn cancel(&self) {
        if !self._cancel.load(Ordering::SeqCst) {
            self._cancel.store(true, Ordering::SeqCst)
        }
    }

    /// Check if the task is canceled.
    #[inline(always)]
    pub fn is_canceled(&self) -> bool {
        self._cancel.load(Ordering::Relaxed)
    }

    /// Get the id of the task
    #[inline(always)]
    pub fn task_id(&self) -> u32 {
        self.id
    }

    #[cfg(feature = "blocking")]
    /// Wait until the task is completed and then get (careful, this is blocking operation).
    #[inline]
    pub fn get(&self) -> Progress<T, E> {
        self.try_do();
        let (awaiting, ready, mtx, cvar) = &*self.states;
        let mut mtx = mtx.lock();
        cvar.wait(&mut mtx);
        let result = mtx.clone();
        *mtx = Progress::Current;
        ready.store(false, Ordering::Relaxed);
        awaiting.store(false, Ordering::Relaxed);
        result
    }

    /// Try to get the progress of the task, it won't block current thread (non-blocking).
    #[inline]
    pub fn try_get(&self) -> Progress<T, E> {
        if self.states.0.load(Ordering::Relaxed) {
            cfg_if! {
                if #[cfg(feature = "blocking")] {
                    let (awaiting, ready, mtx, _) = &*self.states;
                } else {
                    let (awaiting, ready, mtx) = &*self.states;
                }
            }
            if ready.load(Ordering::SeqCst) {
                ready.store(false, Ordering::SeqCst);
                let mut mtx = mtx.lock();
                let result = mtx.clone();
                *mtx = Progress::Current;
                awaiting.store(false, Ordering::Relaxed);
                result
            } else {
                Progress::Current
            }
        } else {
            self.try_do();
            Progress::Current
        }
    }

    /// Check if the task is in progress.
    #[inline(always)]
    pub fn is_in_progress(&self) -> bool {
        self.states.0.load(Ordering::Relaxed)
    }

    /// Check if the task is completed.
    #[inline(always)]
    pub fn is_done(&self) -> bool {
        !self.states.0.load(Ordering::Relaxed)
    }
}