Struct WorkflowContext 

pub struct WorkflowContext { /* private fields */ }

Holds the runtime context for a workflow execution

Implementations

impl WorkflowContext

pub fn new(workflow: &WorkflowDefinition) -> WorkflowResult<Self>

Creates a new workflow context from a workflow definition

pub fn set_status(&mut self, status: StatusPhase)

Sets the overall workflow status

pub fn instance_id(&self) -> &str

Gets the workflow instance ID

pub fn get_status(&self) -> StatusPhase

Gets the current overall workflow status

pub fn set_task_status(&mut self, task: &str, status: StatusPhase)

Sets the status for a specific task

pub fn get_task_status(&self, task: &str) -> Option<StatusPhase>

Gets the current status for a specific task

pub fn set_input(&mut self, value: Value)

pub fn get_input(&self) -> Option<&Value>

pub fn set_output(&mut self, value: Value)

pub fn get_output(&self) -> Option<&Value>

pub fn set_instance_ctx(&mut self, value: Value)

pub fn get_instance_ctx(&self) -> Option<&Value>

pub fn set_raw_input(&mut self, input: &Value)

Sets the raw input in the workflow descriptor

pub fn set_task_name(&mut self, name: &str)

Sets the task name in the current task descriptor

pub fn set_task_raw_input(&mut self, input: &Value)

Sets the task raw input

pub fn set_task_raw_output(&mut self, output: &Value)

Sets the task raw output

pub fn set_task_started_at(&mut self)

Sets the task startedAt timestamp with nested structure: { iso8601: “…”, epoch: { seconds: 123, milliseconds: 123456 } }

pub fn set_task_reference(&mut self, reference: &str)

Sets the task reference (JSON Pointer)

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

Gets the task reference

pub fn get_workflow_json(&self) -> Option<&Value>

Gets the serialized workflow JSON value (for json_pointer resolution)

pub fn set_task_def(&mut self, task: &Value)

Gets the workflow instance ID Sets the task definition in the task descriptor

pub fn inc_iteration(&mut self, position: &str) -> u32

Increments and returns the iteration counter for the given task position. Each time a task executes, this counter is incremented, starting at 1.

pub fn set_retry_attempt(&mut self, attempt: u32)

Sets the retry attempt count in the task descriptor

pub fn clear_task_context(&mut self)

Clears the current task context

pub fn set_secret_manager(&mut self, value: Arc<dyn SecretManager>)

pub fn get_secret_manager(&self) -> Option<&dyn SecretManager>

pub fn clone_secret_manager(&self) -> Option<Arc<dyn SecretManager>>

pub fn set_listener(&mut self, value: Arc<dyn WorkflowExecutionListener>)

pub fn get_listener(&self) -> Option<&dyn WorkflowExecutionListener>

pub fn clone_listener(&self) -> Option<Arc<dyn WorkflowExecutionListener>>

pub fn emit_event(&self, event: WorkflowEvent)

Emits an event to the listener if configured, and publishes as CloudEvent to EventBus

pub fn set_event_bus(&mut self, value: SharedEventBus)

pub fn get_event_bus(&self) -> Option<&SharedEventBus>

pub fn clone_event_bus(&self) -> Option<SharedEventBus>

pub fn set_sub_workflows( &mut self, sub_workflows: HashMap<String, WorkflowDefinition>, )

Sets the sub-workflow registry

pub fn get_sub_workflow( &self, namespace: &str, name: &str, version: &str, ) -> Option<&WorkflowDefinition>

Looks up a sub-workflow by namespace/name/version key

pub fn clone_sub_workflows(&self) -> HashMap<String, WorkflowDefinition>

Clones the entire sub-workflow registry (for propagating to child runners)

pub fn set_handler_registry(&mut self, registry: HandlerRegistry)

Sets the handler registry (replaces all handlers)

pub fn get_handler_registry(&self) -> &HandlerRegistry

Gets a reference to the handler registry

pub fn clone_handler_registry(&self) -> HandlerRegistry

Clones the handler registry (for propagating to child runners)

pub fn set_functions(&mut self, functions: HashMap<String, TaskDefinition>)

Sets the registered function definitions (for call.function resolution)

pub fn get_function(&self, name: &str) -> Option<&TaskDefinition>

Looks up a registered function definition by name

pub fn cancellation_token(&self) -> CancellationToken

Gets a clone of the cancellation token (for use in tokio::select!)

pub fn cancel(&self)

Cancels the workflow (triggers cancellation for all wait points)

pub fn is_cancelled(&self) -> bool

Checks if cancellation has been requested

pub fn suspend(&self) -> bool

Suspends the workflow execution

Returns true if the workflow was successfully suspended, false if it was already suspended.

pub fn resume(&self) -> bool

Resumes a suspended workflow execution

Returns true if the workflow was resumed from a suspended state, false if it was not suspended.

pub fn is_suspended(&self) -> bool

Checks if the workflow is currently suspended

pub async fn wait_for_resume(&self)

Waits until the workflow is resumed (or cancelled)

Should be called from task runners at cooperative yield points when the workflow is detected as suspended.

pub fn set_authorization(&mut self, scheme: &str, parameter: &str)

Sets the authorization descriptor for the current task Called after HTTP authentication succeeds (Basic, Bearer, Digest, OAuth2, OIDC)

pub fn clear_authorization(&mut self)

Clears the authorization descriptor (called after task completes)

pub fn set_local_expr_vars(&mut self, vars: HashMap<String, Value>)

Sets local expression variables (replaces all)

pub fn add_local_expr_vars(&mut self, vars: HashMap<String, Value>)

Adds local expression variables (merges, does not overwrite existing keys)

pub fn remove_local_expr_vars(&mut self, keys: &[&str])

Removes specified local expression variables

pub fn get_vars(&self) -> HashMap<String, Value>

Returns all variables for JQ expression evaluation, using a cache to avoid rebuilding the map on every call.

Trait Implementations

impl Clone for WorkflowContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowContext

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

Formats the value using the given formatter.