refactor: move task_fn into its own crate
This commit is contained in:
TechnoPorg committed
1 parent
b8204c4ed9
commit
fe8de2784b
35 files changed
+125
-135
No files matched your search
-205
@@ -1,205 +0,0 @@
|
||||
//! Input extraction for task dependencies via a list of dependencies.
|
||||
//!
|
||||
//! # Legacy Trait for Internal Use Only
|
||||
//!
|
||||
//! **NOTE**: This module is now primarily for internal use. The `ExtractInput` trait is only
|
||||
//! used by the internal `task_fn` test helper function.
|
||||
//!
|
||||
//! **For regular tasks**: The `#[task]` macro generates inline `run()` methods with
|
||||
//! type-specific extraction logic. This means **ANY type** implementing `Send + Sync`
|
||||
//! works automatically without needing `ExtractInput` implementations!
|
||||
//!
|
||||
//! # How it works
|
||||
//!
|
||||
//! When a task executes, it needs to extract its inputs from type-erased oneshot dependencies.
|
||||
//! Outputs are wrapped in Arc for efficient fanout (cheap Arc clones instead of data clones).
|
||||
//!
|
||||
//! **Modern approach (via `#[task]` macro)**:
|
||||
//! - The macro generates custom extraction logic inline in `run()`
|
||||
//! - Works with ANY type (just needs `Send + Sync + 'static`)
|
||||
//! - No trait implementations needed!
|
||||
//!
|
||||
//! **Legacy approach (via `ExtractInput` trait)**:
|
||||
//! - Used only by the internal `task_fn` test helper
|
||||
//! - Provides implementations for primitives, standard types, and tuples
|
||||
//! - Requires explicit trait implementations for custom types (not recommended)
|
||||
//!
|
||||
//! # Why macros?
|
||||
//!
|
||||
//! Rust lacks variadic generics, so we use macros to generate implementations for:
|
||||
//! - Common primitive/standard types (one impl per type)
|
||||
//! - Tuples of different sizes (one impl per size, up to 8 elements)
|
||||
//!
|
||||
//! This is standard practice in Rust for working with tuples of different arities.
|
||||
|
||||
use std::{collections::HashMap, hash::Hash, sync::Arc};
|
||||
|
||||
use crate::TaskInput;
|
||||
|
||||
/// Helper trait for input extraction from list of dependencies.
|
||||
///
|
||||
/// Type erasure occurs only at the ExecutableNode trait boundary - by the time
|
||||
/// we're in ExtractInput, we know the concrete type and can safely downcast.
|
||||
pub trait ExtractInput: Sized + Clone {
|
||||
type Input: Send;
|
||||
type Retv<'input>;
|
||||
|
||||
fn extract_from_task_input<'input>(
|
||||
input: TaskInput<'input, Self::Input>,
|
||||
) -> Result<Self::Retv<'input>, String>;
|
||||
}
|
||||
|
||||
// Unit type - no dependencies
|
||||
impl ExtractInput for () {
|
||||
type Input = ();
|
||||
type Retv<'input> = ();
|
||||
|
||||
fn extract_from_task_input(_input: TaskInput<'_, Self>) -> Result<Self, String> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
// Implementations for common primitive and standard library types.
|
||||
// These allow tasks to receive these types as single inputs without wrapping in tuples.
|
||||
// Receives Arc<T> from runner, clones the inner value for task consumption.
|
||||
// For custom types, implement ExtractInput following the same pattern.
|
||||
macro_rules! impl_extract_single {
|
||||
($($t:ty),+) => {
|
||||
$(
|
||||
impl ExtractInput for $t {
|
||||
type Input = ($t,);
|
||||
type Retv<'input> = &'input $t;
|
||||
fn extract_from_task_input<'input>(input: TaskInput<'input, Self::Input>) -> Result<Self::Retv<'input>, String> {
|
||||
Ok(input.next().0)
|
||||
}
|
||||
}
|
||||
)+
|
||||
};
|
||||
}
|
||||
|
||||
impl_extract_single!(
|
||||
i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128, usize, f32, f64, bool, char, String
|
||||
);
|
||||
|
||||
// Implement ExtractInput for Result types to support error handling patterns
|
||||
impl<T, E> ExtractInput for Result<T, E>
|
||||
where
|
||||
T: 'static + Clone + Send + Sync,
|
||||
E: 'static + Clone + Send + Sync,
|
||||
{
|
||||
type Input = (Self,);
|
||||
type Retv<'input> = &'input Result<T, E>;
|
||||
|
||||
fn extract_from_task_input<'input>(
|
||||
input: TaskInput<'input, (Self,)>,
|
||||
) -> Result<Self::Retv<'input>, String> {
|
||||
Ok(input.next().0)
|
||||
}
|
||||
}
|
||||
|
||||
// Implement ExtractInput for Option types
|
||||
impl<T> ExtractInput for Option<T>
|
||||
where
|
||||
T: 'static + Clone + Send + Sync,
|
||||
{
|
||||
type Input = (Self,);
|
||||
type Retv<'input> = &'input Option<T>;
|
||||
|
||||
fn extract_from_task_input<'input>(
|
||||
input: TaskInput<'input, (Self,)>,
|
||||
) -> Result<Self::Retv<'input>, String> {
|
||||
Ok(input.next().0)
|
||||
}
|
||||
}
|
||||
|
||||
// Implement ExtractInput for Vec types
|
||||
impl<T> ExtractInput for Vec<T>
|
||||
where
|
||||
T: 'static + Clone + Send + Sync,
|
||||
{
|
||||
type Input = (Self,);
|
||||
type Retv<'input> = &'input Vec<T>;
|
||||
|
||||
fn extract_from_task_input<'input>(
|
||||
input: TaskInput<'input, (Self,)>,
|
||||
) -> Result<Self::Retv<'input>, String> {
|
||||
Ok(input.next().0)
|
||||
}
|
||||
}
|
||||
|
||||
// Implement ExtractInput for HashMap types
|
||||
impl<K, V> ExtractInput for HashMap<K, V>
|
||||
where
|
||||
K: 'static + Clone + Send + Sync + Eq + Hash,
|
||||
V: 'static + Clone + Send + Sync,
|
||||
{
|
||||
type Input = (Self,);
|
||||
type Retv<'input> = &'input HashMap<K, V>;
|
||||
|
||||
fn extract_from_task_input<'input>(
|
||||
input: TaskInput<'input, (Self,)>,
|
||||
) -> Result<Self::Retv<'input>, String> {
|
||||
Ok(input.next().0)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> ExtractInput for Arc<T>
|
||||
where
|
||||
T: 'static + Clone + Send + Sync,
|
||||
{
|
||||
type Input = (Self,);
|
||||
type Retv<'input> = &'input Arc<T>;
|
||||
|
||||
fn extract_from_task_input<'input>(
|
||||
input: TaskInput<'input, (Self,)>,
|
||||
) -> Result<Self::Retv<'input>, String> {
|
||||
Ok(input.next().0)
|
||||
}
|
||||
}
|
||||
|
||||
/// Macro to implement ExtractInput for tuple types.
|
||||
///
|
||||
/// We need separate implementations for each tuple size (2-8) because Rust doesn't support
|
||||
/// variadic generics. This is standard practice when working with tuples in Rust.
|
||||
///
|
||||
/// # Compile-time Safety
|
||||
///
|
||||
/// The number of dependencies is guaranteed to match the tuple size at compile time through:
|
||||
/// 1. The `DepsTuple<Tk::Input>` trait bound on `depends_on()` ensures type/arity matching
|
||||
/// 2. The `IsUnitType` constraint on `From<TaskBuilder>` prevents using tasks without calling `depends_on()`
|
||||
///
|
||||
/// Therefore, no runtime validation is needed - if it compiles, the dependency count is correct.
|
||||
macro_rules! impl_extract_tuple {
|
||||
($($T:ident),+) => {
|
||||
impl<$($T: 'static + Clone + Send + Sync),+> ExtractInput for ($($T,)+) {
|
||||
type Input = Self;
|
||||
type Retv<'input> = ($(&'input $T,)+);
|
||||
|
||||
fn extract_from_task_input<'input>(input: TaskInput<'input, Self::Input>) -> Result<Self::Retv<'input>, String> {
|
||||
$(
|
||||
let ($T, input): (&'input $T, _) = input.next();
|
||||
)+
|
||||
|
||||
let _input: TaskInput<'input, ()> = input;
|
||||
|
||||
Ok(($($T,)+))
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
// Generate ExtractInput implementations for tuples of size 2-8.
|
||||
// Each invocation creates an impl for a specific tuple size.
|
||||
// Supporting up to 8 elements covers the vast majority of use cases.
|
||||
#[allow(non_snake_case)]
|
||||
mod impls {
|
||||
use super::*;
|
||||
|
||||
impl_extract_tuple!(A, B);
|
||||
impl_extract_tuple!(A, B, C);
|
||||
impl_extract_tuple!(A, B, C, D);
|
||||
impl_extract_tuple!(A, B, C, D, E);
|
||||
impl_extract_tuple!(A, B, C, D, E, F);
|
||||
impl_extract_tuple!(A, B, C, D, E, F, G);
|
||||
impl_extract_tuple!(A, B, C, D, E, F, G, H);
|
||||
}
|
||||
@@ -770,7 +770,6 @@ extern crate self as dagx;
|
||||
mod builder;
|
||||
mod deps;
|
||||
mod error;
|
||||
mod extract;
|
||||
mod node;
|
||||
mod runner;
|
||||
mod task;
|
||||
@@ -785,7 +784,3 @@ pub use types::{Pending, TaskHandle};
|
||||
|
||||
// Re-export the procedural macro
|
||||
pub use dagx_macros::task;
|
||||
|
||||
// Internal testing support - not part of the public API
|
||||
#[doc(hidden)]
|
||||
pub use task::task_fn;
|
||||
-47
@@ -5,8 +5,6 @@
|
||||
|
||||
use std::{any::Any, future::Future, marker::PhantomData, slice::Iter, sync::Arc};
|
||||
|
||||
use crate::extract::ExtractInput;
|
||||
|
||||
/// A unit of async work with typed inputs and outputs.
|
||||
///
|
||||
/// Use the [`task`](crate::task) macro to implement this trait. The macro automatically
|
||||
@@ -149,50 +147,5 @@ impl TaskInput<'static, ()> {
|
||||
}
|
||||
}
|
||||
|
||||
/// **INTERNAL USE ONLY**: This struct is for testing purposes only and should
|
||||
/// not be used in production code. Use the `#[task]` macro instead.
|
||||
#[doc(hidden)]
|
||||
pub struct TaskFn<I, O, F>
|
||||
where
|
||||
for<'input> F: FnMut(I::Retv<'input>) -> O + Send,
|
||||
I: ExtractInput + Send + Sync + 'static,
|
||||
O: Send,
|
||||
{
|
||||
f: F,
|
||||
_phantom: std::marker::PhantomData<fn(I) -> O>,
|
||||
}
|
||||
|
||||
impl<I, O, F> Task for TaskFn<I, O, F>
|
||||
where
|
||||
for<'input> F: FnMut(I::Retv<'input>) -> O + Send,
|
||||
I: ExtractInput + Send + Sync + 'static,
|
||||
O: Send + Sync,
|
||||
{
|
||||
type Input = I::Input;
|
||||
type Output = O;
|
||||
|
||||
async fn run(mut self, input: TaskInput<'_, I::Input>) -> O {
|
||||
(self.f)(I::extract_from_task_input(input).unwrap())
|
||||
}
|
||||
}
|
||||
|
||||
/// Convenience function to create a task from a closure.
|
||||
///
|
||||
/// **INTERNAL USE ONLY**: This function is for testing purposes only and should
|
||||
/// not be used in production code. Use the `#[task]` macro instead.
|
||||
#[doc(hidden)]
|
||||
pub fn task_fn<I, O, F>(f: F) -> TaskFn<I, O, F>
|
||||
where
|
||||
for<'input> F: FnMut(I::Retv<'input>) -> O + Send,
|
||||
I: ExtractInput + Send + Sync + 'static,
|
||||
I::Input: Send + Sync + 'static,
|
||||
O: Send + Sync + 'static,
|
||||
{
|
||||
TaskFn {
|
||||
f,
|
||||
_phantom: std::marker::PhantomData,
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
Reference in new issue
Block a user