Skip to main content

ToolTask

Struct ToolTask 

Source
pub struct ToolTask { /* private fields */ }
Expand description

Task that invokes a registered tool from the ToolRegistry.

ToolTask executes external tools (magellan, cargo, splice, etc.) with configurable fallback handlers for error recovery.

§Example

use forge_agent::workflow::tasks::ToolTask;
use forge_agent::workflow::tools::ToolInvocation;
use forge_agent::workflow::TaskId;

let task = ToolTask::new(
    TaskId::new("tool_task"),
    "Magellan Query".to_string(),
    "magellan"
)
.args(vec!["find".to_string(), "--name".to_string(), "symbol".to_string()]);

Implementations§

Source§

impl ToolTask

Source

pub fn new(id: TaskId, name: String, tool_name: impl Into<String>) -> Self

Creates a new ToolTask.

§Arguments
  • id - Task identifier
  • name - Human-readable task name
  • tool_name - Name of the registered tool to invoke
§Example
use forge_agent::workflow::tasks::ToolTask;
use forge_agent::workflow::TaskId;

let task = ToolTask::new(
    TaskId::new("tool_task"),
    "Query Magellan".to_string(),
    "magellan"
);
Source

pub fn args(self, args: Vec<String>) -> Self

Sets the arguments for the tool invocation.

§Arguments
  • args - Vector of argument strings
§Returns

Self for builder pattern chaining

§Example
use forge_agent::workflow::tasks::ToolTask;
use forge_agent::workflow::TaskId;

let task = ToolTask::new(
    TaskId::new("tool_task"),
    "Query Magellan".to_string(),
    "magellan"
)
.args(vec!["find".to_string(), "--name".to_string(), "symbol".to_string()]);
Source

pub fn working_dir(self, dir: impl Into<PathBuf>) -> Self

Sets the working directory for the tool invocation.

§Arguments
  • dir - Working directory path
§Returns

Self for builder pattern chaining

§Example
use forge_agent::workflow::tasks::ToolTask;
use forge_agent::workflow::TaskId;

let task = ToolTask::new(
    TaskId::new("tool_task"),
    "Run cargo".to_string(),
    "cargo"
)
.working_dir("/home/user/project");
Source

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Adds an environment variable to the tool invocation.

§Arguments
  • key - Environment variable name
  • value - Environment variable value
§Returns

Self for builder pattern chaining

§Example
use forge_agent::workflow::tasks::ToolTask;
use forge_agent::workflow::TaskId;

let task = ToolTask::new(
    TaskId::new("tool_task"),
    "Run cargo".to_string(),
    "cargo"
)
.env("RUST_LOG", "debug");
Source

pub fn with_fallback(self, handler: Box<dyn FallbackHandler>) -> Self

Sets the fallback handler for error recovery.

§Arguments
  • handler - Fallback handler to use on tool failure
§Returns

Self for builder pattern chaining

§Example
use forge_agent::workflow::tasks::ToolTask;
use forge_agent::workflow::tools::RetryFallback;
use forge_agent::workflow::TaskId;

let task = ToolTask::new(
    TaskId::new("tool_task"),
    "Query Magellan".to_string(),
    "magellan"
)
.with_fallback(Box::new(RetryFallback::new(3, 100)));
Source

pub fn tool_name(&self) -> &str

Gets the tool name for this task.

Source

pub fn invocation(&self) -> &ToolInvocation

Gets the invocation for this task.

Trait Implementations§

Source§

impl WorkflowTask for ToolTask

Source§

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, context: &'life1 TaskContext, ) -> Pin<Box<dyn Future<Output = Result<TaskResult, TaskError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the task with the provided context. Read more
Source§

fn id(&self) -> TaskId

Returns the unique task identifier.
Source§

fn name(&self) -> &str

Returns the human-readable task name.
Source§

fn compensation(&self) -> Option<CompensationAction>

Returns the compensation action for this task (if any). Read more
Source§

fn dependencies(&self) -> Vec<TaskId>

Returns the list of task dependencies. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more