Skip to main content

WorkflowBuilder

Struct WorkflowBuilder 

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

Fluent builder for constructing workflows.

WorkflowBuilder provides a chainable API for creating workflows with multiple tasks and dependencies between them.

§Example

use forge_agent::workflow::{WorkflowBuilder, MockTask, TaskId};

let workflow = WorkflowBuilder::new()
    .add_task(Box::new(MockTask::new("a", "Task A")))
    .add_task(Box::new(MockTask::new("b", "Task B")))
    .add_task(Box::new(MockTask::new("c", "Task C")))
    .dependency(TaskId::new("a"), TaskId::new("b"))
    .dependency(TaskId::new("b"), TaskId::new("c"))
    .build()
    .unwrap();

Implementations§

Source§

impl WorkflowBuilder

Source

pub fn new() -> Self

Creates a new WorkflowBuilder.

Source

pub fn with_auto_detect(self, forge: &Forge) -> Self

Configures the builder with a Forge instance for auto-detection.

§Arguments
  • forge - Forge instance for graph-based dependency detection
§Returns

Self for method chaining

§Example
let builder = WorkflowBuilder::new()
    .with_auto_detect(&forge)
    .add_task(Box::new(GraphQueryTask::find_symbol("main")));
Source

pub fn add_task(self, task: Box<dyn WorkflowTask>) -> Self

Adds a task to the workflow.

§Arguments
  • task - Boxed trait object implementing WorkflowTask
§Returns

Self for method chaining

§Example
let builder = WorkflowBuilder::new()
    .add_task(Box::new(MockTask::new("task-1", "First Task")));
Source

pub fn dependency(self, from: TaskId, to: TaskId) -> Self

Adds a dependency between two tasks.

Creates a directed edge from from to to, indicating that to depends on from (from must execute first).

§Arguments
  • from - Task ID of the prerequisite (executes first)
  • to - Task ID of the dependent (executes after)
§Returns

Self for method chaining

§Note

Dependencies are validated when build is called. Invalid dependencies (cycles, missing tasks) will cause build to fail.

§Example
let builder = WorkflowBuilder::new()
    .add_task(Box::new(MockTask::new("a", "Task A")))
    .add_task(Box::new(MockTask::new("b", "Task B")))
    .dependency(TaskId::new("a"), TaskId::new("b"));
Source

pub fn build(self) -> Result<Workflow, WorkflowError>

Builds the workflow from configured tasks and dependencies.

§Returns
  • Ok(Workflow) - If workflow is valid
  • Err(WorkflowError) - If validation fails (cycles, missing tasks, empty)
§Errors
  • WorkflowError::EmptyWorkflow - No tasks were added
  • WorkflowError::CycleDetected - Dependencies contain a cycle
  • WorkflowError::TaskNotFound - Dependency references non-existent task
§Example
let workflow = WorkflowBuilder::new()
    .add_task(Box::new(MockTask::new("task-1", "Task")))
    .build()
    .unwrap();
Source

pub async fn build_auto_detect(self) -> Result<Workflow, WorkflowError>

Builds the workflow with automatic dependency detection.

This method builds the workflow, runs dependency detection using the stored Forge instance, applies high-confidence suggestions, and validates the completed workflow.

§Returns
  • Ok(Workflow) - Valid workflow with auto-detected dependencies
  • Err(WorkflowError) - If validation fails or no Forge configured
§Errors
  • WorkflowError::EmptyWorkflow - No tasks were added
  • WorkflowError::CycleDetected - Auto-detection created a cycle
  • WorkflowError::TaskNotFound - Dependency references non-existent task
§Example
let workflow = WorkflowBuilder::new()
    .with_auto_detect(&forge)
    .add_task(Box::new(GraphQueryTask::find_symbol("process_data")))
    .add_task(Box::new(GraphQueryTask::references("process_data")))
    .build_auto_detect()
    .await?;
Source

pub fn sequential( tasks: Vec<Box<dyn WorkflowTask>>, ) -> Result<Workflow, WorkflowError>

Creates a sequential workflow from a list of tasks.

Tasks are executed in the order provided, with each task depending on the previous task.

§Arguments
  • tasks - Vector of boxed trait objects in execution order
§Returns
  • Ok(Workflow) - If workflow is valid
  • Err(WorkflowError) - If tasks vector is empty
§Example
let workflow = WorkflowBuilder::sequential(vec![
    Box::new(MockTask::new("step-1", "Step 1")),
    Box::new(MockTask::new("step-2", "Step 2")),
    Box::new(MockTask::new("step-3", "Step 3")),
]).unwrap();

Trait Implementations§

Source§

impl Default for WorkflowBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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