Struct Workflow 

pub struct Workflow { /* private fields */ }

A built, runnable workflow graph.

Implementations

impl Workflow

pub fn name(&self) -> Option<&str>

The workflow name, if set.

pub fn description(&self) -> Option<&str>

The workflow description, if set.

pub fn id(&self) -> &str

The workflow’s unique id.

pub fn start_executor_id(&self) -> &str

The start executor id.

pub fn graph_signature(&self) -> &str

This workflow’s deterministic graph signature (see WorkflowBuilder::build). Checkpoints record the signature of the graph that produced them; Workflow::run_from_checkpoint refuses to resume a checkpoint whose signature does not match this workflow’s.

pub async fn run(&self, input: impl Into<Value>) -> Result<WorkflowRun, Error>

Run the workflow to completion (or until it pauses awaiting external input), returning the run handle with observed events and final state.

pub fn run_stream(&self, input: impl Into<Value>) -> WorkflowRunStream

Run the workflow, streaming events as they happen.

Returns a WorkflowRunStream that yields WorkflowEvents live; call WorkflowRunStream::into_run after the stream ends to obtain the final WorkflowRun state.

pub async fn run_from_checkpoint( &self, checkpoint_id: &str, storage: Arc<dyn CheckpointStorage>, ) -> Result<WorkflowRun, Error>

Restore a run from a checkpoint and continue it to completion (or pause).

Restores the in-flight message queue, iteration count, shared state, executor states, and any outstanding requests.

Before restoring, the checkpoint’s recorded graph signature is compared against this workflow’s: a mismatch is a hard Error::Workflow (the topology changed since the checkpoint was saved, so resuming could misroute messages or drop executor state). A legacy checkpoint carrying no signature is resumed with a warning. Use Workflow::run_from_checkpoint_unchecked to bypass the check.

pub async fn run_from_checkpoint_unchecked( &self, checkpoint_id: &str, storage: Arc<dyn CheckpointStorage>, ) -> Result<WorkflowRun, Error>

Like Workflow::run_from_checkpoint, but skips graph-signature validation (a mismatch is logged, not rejected). For deliberately resuming a checkpoint into an intentionally-evolved graph, where the caller accepts responsibility for compatibility.

pub fn viz(&self) -> WorkflowViz<'_>

A visualization helper (Mermaid / Graphviz DOT) for this workflow.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl WorkflowAgentExt for Workflow

fn as_agent(&self, name: impl Into<String>) -> WorkflowAgent

Wrap this workflow as a WorkflowAgent named name.