Skip to main content

TaskNode

swiftide::tasks

Trait TaskNode

pub trait TaskNode:
    Send
    + Sync
    + DynClone
    + Any {
    type Input: NodeArg;
    type Output: NodeArg;
    type Error: Error + Send + Sync + 'static;

    // Required method
    fn evaluate<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        node_id: &'life1 NodeId<dyn TaskNode<Error = Self::Error, Output = Self::Output, Input = Self::Input>>,
        input: &'life2 Self::Input,
    ) -> Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             Self: 'async_trait;
}

Available on crate feature swiftide-tasks only.

Expand description

A typed step in a Task.

Implement this trait for your own domain-specific nodes when you want full control over how a task step runs. For lightweight closure nodes, use Task::register_node_fn, or Task::register_node_async_fn for async closures.

Required Associated Types§

type Input: NodeArg

The input accepted by this node.

type Output: NodeArg

The output produced by this node.

type Error: Error + Send + Sync + 'static

The error returned when evaluation fails.

Required Methods§

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, node_id: &'life1 NodeId<dyn TaskNode<Error = Self::Error, Output = Self::Output, Input = Self::Input>>, input: &'life2 Self::Input, ) -> Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Evaluates the node with the current input.

Trait Implementations§

impl<Input, Output, Error> TaskNode for Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>>
where Input: NodeArg, Output: NodeArg, Error: Error + Send + Sync + 'static,

type Input = Input

The input accepted by this node.

type Output = Output

The output produced by this node.

type Error = Error

The error returned when evaluation fails.

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, node_id: &'life1 NodeId<dyn TaskNode<Error = <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Error, Output = <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Output, Input = <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Input>>, input: &'life2 <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Output, <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>>: 'async_trait,

Evaluates the node with the current input.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

impl TaskNode for Arc<dyn ChatCompletion>

type Input = ChatCompletionRequest<'static>

type Output = ChatCompletionResponse

type Error = LanguageModelError

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 NodeId<dyn TaskNode<Error = <Arc<dyn ChatCompletion> as TaskNode>::Error, Output = <Arc<dyn ChatCompletion> as TaskNode>::Output, Input = <Arc<dyn ChatCompletion> as TaskNode>::Input>>, input: &'life2 <Arc<dyn ChatCompletion> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Arc<dyn ChatCompletion> as TaskNode>::Output, <Arc<dyn ChatCompletion> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Arc<dyn ChatCompletion>: 'async_trait,

impl TaskNode for Arc<dyn SimplePrompt>

type Input = Prompt

type Output = String

type Error = LanguageModelError

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 NodeId<dyn TaskNode<Error = <Arc<dyn SimplePrompt> as TaskNode>::Error, Output = <Arc<dyn SimplePrompt> as TaskNode>::Output, Input = <Arc<dyn SimplePrompt> as TaskNode>::Input>>, input: &'life2 <Arc<dyn SimplePrompt> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Arc<dyn SimplePrompt> as TaskNode>::Output, <Arc<dyn SimplePrompt> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Arc<dyn SimplePrompt>: 'async_trait,

impl TaskNode for Arc<dyn ToolExecutor>

type Input = Command

type Output = CommandOutput

type Error = CommandError

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 NodeId<dyn TaskNode<Error = <Arc<dyn ToolExecutor> as TaskNode>::Error, Output = <Arc<dyn ToolExecutor> as TaskNode>::Output, Input = <Arc<dyn ToolExecutor> as TaskNode>::Input>>, input: &'life2 <Arc<dyn ToolExecutor> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Arc<dyn ToolExecutor> as TaskNode>::Output, <Arc<dyn ToolExecutor> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Arc<dyn ToolExecutor>: 'async_trait,

impl TaskNode for Box<dyn ChatCompletion>

type Input = ChatCompletionRequest<'static>

type Output = ChatCompletionResponse

type Error = LanguageModelError

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 NodeId<dyn TaskNode<Error = <Box<dyn ChatCompletion> as TaskNode>::Error, Output = <Box<dyn ChatCompletion> as TaskNode>::Output, Input = <Box<dyn ChatCompletion> as TaskNode>::Input>>, input: &'life2 <Box<dyn ChatCompletion> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Box<dyn ChatCompletion> as TaskNode>::Output, <Box<dyn ChatCompletion> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Box<dyn ChatCompletion>: 'async_trait,

impl TaskNode for Box<dyn SimplePrompt>

type Input = Prompt

type Output = String

type Error = LanguageModelError

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 NodeId<dyn TaskNode<Error = <Box<dyn SimplePrompt> as TaskNode>::Error, Output = <Box<dyn SimplePrompt> as TaskNode>::Output, Input = <Box<dyn SimplePrompt> as TaskNode>::Input>>, input: &'life2 <Box<dyn SimplePrompt> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Box<dyn SimplePrompt> as TaskNode>::Output, <Box<dyn SimplePrompt> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Box<dyn SimplePrompt>: 'async_trait,

impl TaskNode for Box<dyn ToolExecutor>

type Input = Command

type Output = CommandOutput

type Error = CommandError

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 NodeId<dyn TaskNode<Error = <Box<dyn ToolExecutor> as TaskNode>::Error, Output = <Box<dyn ToolExecutor> as TaskNode>::Output, Input = <Box<dyn ToolExecutor> as TaskNode>::Input>>, input: &'life2 <Box<dyn ToolExecutor> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Box<dyn ToolExecutor> as TaskNode>::Output, <Box<dyn ToolExecutor> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Box<dyn ToolExecutor>: 'async_trait,

impl<Input, Output, Error> TaskNode for Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>>
where Input: NodeArg, Output: NodeArg, Error: Error + Send + Sync + 'static,

type Input = Input

type Output = Output

type Error = Error

fn evaluate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, node_id: &'life1 NodeId<dyn TaskNode<Error = <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Error, Output = <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Output, Input = <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Input>>, input: &'life2 <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Input, ) -> Pin<Box<dyn Future<Output = Result<<Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Output, <Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>> as TaskNode>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Box<dyn TaskNode<Error = Error, Output = Output, Input = Input>>: 'async_trait,

Implementors§

impl TaskNode for TaskAgent

type Input = Prompt

type Output = ()

type Error = AgentError

impl<F, I, O, E> TaskNode for AsyncFn<F, I, O, E>
where F: for<'a> Fn(&'a I) -> Pin<Box<dyn Future<Output = Result<O, E>> + Send + 'a>> + Clone + Send + Sync + 'static, I: NodeArg + Clone, O: NodeArg + Clone, E: Error + Send + Sync + 'static,

type Input = I

type Output = O

type Error = E

impl<F, I, O, E> TaskNode for SyncFn<F, I, O, E>
where F: Fn(&I) -> Result<O, E> + Clone + Send + Sync + 'static, I: NodeArg + Clone, O: NodeArg + Clone, E: Error + Send + Sync + 'static,

type Input = I

type Output = O

type Error = E