Struct WorkflowBuilder 

pub struct WorkflowBuilder { /* private fields */ }

Fluent, validation-preserving workflow assembly.

Implementations

impl WorkflowBuilder

pub fn new(name: impl Into<String>) -> Self

Creates an empty version-one workflow definition.

pub fn version(self, version: u32) -> Self

Sets the durable workflow definition version.

pub fn timer(self, id: impl Into<String>, delay: Duration) -> Self

Appends a durable timer that releases its worker lease while waiting.

pub fn wait_for_signal( self, id: impl Into<String>, signal: impl Into<String>, ) -> Self

Appends a durable external-signal wait targeted by checkpoint identity.

pub fn wait_for_signal_or_timeout( self, id: impl Into<String>, signal: impl Into<String>, timeout: Duration, ) -> Self

Appends a durable race between an external signal and a timeout.

pub fn interrupt(self, id: impl Into<String>, prompt: impl Into<String>) -> Self

Suspends until a human approves, edits, or rejects the current value.

The request and current proposal are checkpointed before the worker releases its lease. Reviewers can inspect the generated interrupt identity and submit an idempotent decision through crate::WorkflowStore.

pub fn step<S>( self, id: impl Into<String>, step: S, capabilities: CapabilitySet, ) -> Self

where S: WorkflowStep + 'static,

Appends one custom executable step.

pub fn agent( self, id: impl Into<String>, agent: Arc<Agent>, capabilities: CapabilitySet, ) -> Self

Appends one Agent-backed step.

pub fn branch<C, T, F>( self, id: impl Into<String>, condition: C, when_true: T, when_false: F, capabilities: CapabilitySet, ) -> Self

where C: WorkflowCondition + 'static, T: WorkflowStep + 'static, F: WorkflowStep + 'static,

Appends a condition that executes exactly one of two steps.

pub fn parallel( self, id: impl Into<String>, branches: impl IntoIterator<Item = ParallelBranch>, ) -> Self

Appends a deterministic fan-out/fan-in parallel node.

Every branch receives the same canonical input. Outputs are joined into an object keyed by branch identifier, independent of completion order.

pub fn race( self, id: impl Into<String>, branches: impl IntoIterator<Item = ParallelBranch>, ) -> Self

Appends a budget-bounded, first-success race.

Race branches may request only Pure or ReadOnly capabilities. Losing reservations are conservatively forfeited because remote work may outlive local cancellation.

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

Validates and freezes this workflow definition.

Errors

Returns WorkflowBuildError for invalid identity, version, duplicate steps, or an empty definition.

Trait Implementations

impl Debug for WorkflowBuilder

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.