Struct WorkflowContextView 

#[non_exhaustive]
pub struct WorkflowContextView { /* private fields */ }

Read-only view of workflow context for use in init, query, and update-validator handlers.

This provides access to workflow information but cannot issue commands.

Implementations

impl WorkflowContextView

pub fn workflow_id(&self) -> &str

Returns the workflow’s unique identifier.

pub fn run_id(&self) -> &str

Returns the run ID of this workflow execution.

pub fn workflow_type(&self) -> &str

Returns the workflow type name.

pub fn task_queue(&self) -> &str

Returns the task queue this workflow is executing on.

pub fn namespace(&self) -> &str

Returns the namespace this workflow is executing in.

pub fn attempt(&self) -> u32

Returns the current attempt number, starting from one.

pub fn first_execution_run_id(&self) -> &str

Returns the run ID of the first execution in the chain.

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

Returns the run ID of the previous execution when this is a continuation.

pub fn start_time(&self) -> Option<SystemTime>

Returns when the workflow execution started.

pub fn execution_timeout(&self) -> Option<Duration>

Returns the total workflow execution timeout, including retries and continue-as-new.

pub fn run_timeout(&self) -> Option<Duration>

Returns the timeout of a single workflow run.

pub fn task_timeout(&self) -> Option<Duration>

Returns the timeout of a single workflow task.

pub fn parent(&self) -> Option<NamespacedWorkflowInfo>

Returns information about the parent workflow when this is a child workflow.

pub fn root(&self) -> Option<WorkflowExecution>

Returns information about the root workflow in the execution chain.

pub fn retry_policy(&self) -> Option<RetryPolicy>

Returns the workflow’s retry policy.

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

Returns the cron schedule when this workflow runs on one.

pub fn priority(&self) -> Priority

Returns priority and fairness configuration for this workflow execution.

pub fn memo(&self) -> Memo

Returns user-defined memo values.

pub fn search_attributes(&self) -> Option<SearchAttributes>

Returns initial search attributes as a typed collection.

pub fn context_value<K>(&self) -> Option<Rc<<K as WorkflowContextKey>::Value>>

where K: WorkflowContextKey,

Return the value associated with key type K in the current workflow context scope.

This allows queries and update validators to observe values established by synchronous inbound interceptors without allowing the handler to modify the context scope.

pub fn raw(&self) -> &InitializeWorkflow

Accesses the underlying workflow initialization protobuf.

pub fn into_raw(self) -> InitializeWorkflow

Consumes this view and returns the underlying workflow initialization protobuf.

Trait Implementations

impl Clone for WorkflowContextView

fn clone(&self) -> WorkflowContextView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowContextView

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

Formats the value using the given formatter.