ordr_core 0.1.0

The core part of `ordr` (which is probably the one you want).
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

use std::{
    any::{Any, TypeId},
    pin::Pin,
    sync::Arc,
};

/// Bytes that can be stored in a generic manner, and transferred across threads.
pub(crate) type Payload = Box<dyn Any + Send>;

/// Output of the execute function on a [`Node`].
type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;

/// Struct describing everything needed to find dependencies and execute this node.
#[derive(Clone)]
#[allow(clippy::type_complexity)]
pub struct Node<C, E> {
    /// Name of this node. Only used for display.
    pub name: &'static str,

    /// The ID of this Node.
    pub id: TypeId,

    /// List of dependencies.
    pub deps: Vec<TypeId>,

    #[doc(hidden)]
    pub prepare: Arc<dyn Fn(Vec<&Payload>) -> Payload + Send + Sync + 'static>,

    #[doc(hidden)]
    pub execute:
        Arc<dyn Fn(C, Payload) -> BoxFuture<'static, Result<Payload, E>> + Send + Sync + 'static>,
}

/// Trait for creating a [`Node`] from an executor function.
///
/// Should be implemented automatically using the `executor` macro.
pub trait NodeBuilder<C, E> {
    /// Create node.
    fn node() -> Node<C, E>;
}