Struct WorkflowExecution 

pub struct WorkflowExecution {
    pub execution_id: Uuid,
    pub workflow_name: String,
    /* private fields */
}

Handle for managing an asynchronous workflow execution.

This struct provides methods to monitor and control a running workflow execution. It can be used to check status, wait for completion, or cancel the execution.

Fields

execution_id: Uuid

Unique identifier for this execution

workflow_name: String

Name of the workflow being executed

Implementations

impl WorkflowExecution

pub fn new( execution_id: Uuid, workflow_name: String, executor: DefaultRunner, ) -> Self

Creates a new workflow execution handle.

Arguments

• execution_id - Unique identifier for the execution
• workflow_name - Name of the workflow being executed
• executor - The executor instance managing this execution

pub async fn wait_for_completion( self, ) -> Result<WorkflowExecutionResult, WorkflowExecutionError>

Waits for the workflow to complete execution.

This method blocks until the workflow reaches a terminal state.

Returns

• Ok(WorkflowExecutionResult) - The final result of the workflow execution
• Err(WorkflowExecutionError) - If the execution fails or encounters an error

pub async fn wait_for_completion_with_timeout( self, timeout: Option<Duration>, ) -> Result<WorkflowExecutionResult, WorkflowExecutionError>

Waits for completion with a specified timeout.

Arguments

• timeout - Optional duration after which to timeout the wait

Returns

• Ok(WorkflowExecutionResult) - The final result of the workflow execution
• Err(WorkflowExecutionError) - If the execution fails, times out, or encounters an error

pub async fn get_status(&self) -> Result<WorkflowStatus, WorkflowExecutionError>

Gets the current status of the workflow execution.

Returns

• Ok(WorkflowStatus) - The current status of the execution
• Err(WorkflowExecutionError) - If the status cannot be retrieved

pub async fn cancel(&self) -> Result<(), WorkflowExecutionError>

Cancels the workflow execution.

This method attempts to gracefully stop the workflow execution.

Returns

• Ok(()) - If the cancellation was successful
• Err(WorkflowExecutionError) - If the cancellation failed

pub async fn pause( &self, reason: Option<&str>, ) -> Result<(), WorkflowExecutionError>

Pauses the workflow execution.

When paused, no new tasks will be scheduled, but in-flight tasks will complete normally. The workflow can be resumed later.

Arguments

• reason - Optional reason for pausing the execution

Returns

• Ok(()) - If the pause was successful
• Err(WorkflowExecutionError) - If the pause failed

pub async fn resume(&self) -> Result<(), WorkflowExecutionError>

Resumes a paused workflow execution.

The scheduler will resume scheduling tasks for this workflow on the next poll cycle.

Returns

• Ok(()) - If the resume was successful
• Err(WorkflowExecutionError) - If the resume failed