computation-process 0.2.0

A Rust library for defining stateful computations (and generators) that support suspend/resume, interleaving, cancellation and serialization.
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

use crate::{Completable, DynGeneratable};
use cancel_this::Cancellable;

/// An alternative to [`crate::Computable`] which is intended for generators.
///
/// The computation is finished once [`Generatable::try_next`] returns `None`.
pub trait Generatable<T>: Iterator<Item = Cancellable<T>> {
    /// Try to advance the generator and return the next item.
    ///
    /// Returns:
    /// - `Some(Ok(item))` when an item is available
    /// - `Some(Err(Incomplete::Suspended))` when the generator needs to yield control
    /// - `Some(Err(Incomplete::Cancelled(_)))` when the computation was canceled
    /// - `None` when the generator is exhausted
    fn try_next(&mut self) -> Option<Completable<T>>;

    /// Utility method to convert this [`Generatable`] to a dynamic type.
    fn dyn_generatable(self) -> DynGeneratable<T>
    where
        Self: Sized + 'static,
    {
        Box::new(self)
    }
}