Struct SyncWorkflowContext 

pub struct SyncWorkflowContext<W> { /* private fields */ }

Context provided to synchronous signal and update handlers.

This type provides all workflow context capabilities except state(), state_mut(), and wait_condition(). Those methods are not applicable in sync handler contexts.

Sync handlers receive &mut self directly, so they can reference and mutate workflow state without needing state()/state_mut().

Implementations

impl<W> SyncWorkflowContext<W>

pub fn workflow_id(&self) -> &str

Return the workflow’s unique identifier

pub fn run_id(&self) -> &str

Return the run id of this workflow execution

pub fn namespace(&self) -> &str

Return the namespace the workflow is executing in

pub fn task_queue(&self) -> &str

Return the task queue the workflow is executing in

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

Return the current time according to the workflow (which is not wall-clock time).

pub fn history_length(&self) -> u32

Return the length of history so far at this point in the workflow

pub fn current_deployment_version(&self) -> Option<WorkerDeploymentVersion>

Return the deployment version, if any, as it was when this point in the workflow was first reached. If this code is being executed for the first time, return this Worker’s deployment version if it has one.

pub fn search_attributes(&self) -> impl Deref<Target = SearchAttributes> + '_

Return current values for workflow search attributes

pub fn random_seed(&self) -> u64

Return the workflow’s randomness seed

pub fn is_replaying(&self) -> bool

Returns true if the current workflow task is happening under replay

pub fn continue_as_new_suggested(&self) -> bool

Returns true if the server suggests this workflow should continue-as-new

pub fn headers(&self) -> &HashMap<String, Payload>

Returns the headers for the current handler invocation (signal, update, query, etc.).

When called from within a signal handler, returns the headers that were sent with that signal. When called from the main workflow run method, returns an empty map.

pub fn payload_converter(&self) -> &PayloadConverter

Returns the PayloadConverter currently used by the worker running this workflow.

pub fn workflow_initial_info(&self) -> &InitializeWorkflow

Return various information that the workflow was initialized with. Will eventually become a proper non-proto workflow info struct.

pub fn cancelled(&self) -> impl FusedFuture<Output = String> + '_

A future that resolves if/when the workflow is cancelled, with the user provided cause

pub fn continue_as_new( &self, input: &<W::Run as WorkflowDefinition>::Input, opts: ContinueAsNewOptions, ) -> Result<Infallible, WorkflowTermination>

where W: WorkflowImplementation,

Signal that this workflow should continue as a new workflow execution with the given input and options.

This always returns an Err which should be propigated.

pub fn timer<T: Into<TimerOptions>>( &self, opts: T, ) -> impl CancellableFuture<TimerResult>

Request to create a timer

pub fn start_activity<AD: ActivityDefinition>( &self, activity: AD, input: impl Into<AD::Input>, opts: ActivityOptions, ) -> impl CancellableFuture<Result<AD::Output, ActivityExecutionError>>

where AD::Output: TemporalDeserializable,

Request to run an activity

pub fn start_local_activity<AD: ActivityDefinition>( &self, activity: AD, input: impl Into<AD::Input>, opts: LocalActivityOptions, ) -> impl CancellableFuture<Result<AD::Output, ActivityExecutionError>>

where AD::Output: TemporalDeserializable,

Request to run a local activity

pub fn child_workflow<WD: WorkflowDefinition>( &self, workflow: WD, input: impl Into<WD::Input>, opts: ChildWorkflowOptions, ) -> impl CancellableFutureWithReason<Result<StartedChildWorkflow<WD>, ChildWorkflowExecutionError>>

where WD::Output: TemporalDeserializable,

Start a child workflow. Returns a future that resolves to a StartedChildWorkflow which can be used to await the result, send signals, or cancel the child.

pub fn patched(&self, patch_id: &str) -> bool

Check (or record) that this workflow history was created with the provided patch

pub fn deprecate_patch(&self, patch_id: &str) -> bool

Record that this workflow history was created with the provided patch, and it is being phased out.

pub fn external_workflow( &self, workflow_id: impl Into<String>, run_id: Option<String>, ) -> ExternalWorkflowHandle

Get a handle to an external workflow for sending signals or requesting cancellation.

pub fn upsert_search_attributes( &self, attr_iter: impl IntoIterator<Item = (String, Payload)>, )

Add or create a set of search attributes

pub fn upsert_memo( &self, attr_iter: impl IntoIterator<Item = (String, Payload)>, )

Add or create a set of search attributes

pub fn set_current_details(&self, details: impl Into<String>)

Set the current details string for this workflow execution.

The value is surfaced to the Temporal server UI in real time via the the workflow metadata query.

pub fn force_task_fail(&self, with: Error)

Force a workflow task failure (EX: in order to retry on non-sticky queue)

pub fn start_nexus_operation( &self, opts: NexusOperationOptions, ) -> impl CancellableFuture<Result<StartedNexusOperation, Failure>>

Start a nexus operation

Trait Implementations

impl<W> Clone for SyncWorkflowContext<W>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.