Struct WorkflowInterceptorContext 

pub struct WorkflowInterceptorContext { /* private fields */ }

Workflow execution context available to async-capable inbound interceptors.

Implementations

impl WorkflowInterceptorContext

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.

pub fn with_context_value<K, F>( &self, value: <K as WorkflowContextKey>::Value, future: F, ) -> WorkflowContextFuture<F>

where K: WorkflowContextKey, F: Future,

Poll future with value installed for key type K.

Inbound interceptors can use this to establish context around next.run(input). Outbound interceptors invoked by the workflow inside that scope observe the value with Self::context_value. The previous context is restored after each poll.

pub fn with_context_value_sync<K, R>( &self, value: <K as WorkflowContextKey>::Value, f: impl FnOnce() -> R, ) -> R

where K: WorkflowContextKey,

Run synchronous interceptor code with value installed for key type K.

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_type(&self) -> &str

Return the workflow type name.

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

Return the current time according to the workflow.

pub fn history_length(&self) -> u32

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

pub fn search_attributes(&self) -> SearchAttributes

Return current values for workflow search attributes.

pub fn is_replaying(&self) -> bool

Returns true if the workflow is replaying (including during queries and update validators), false otherwise.

pub fn is_replaying_history_events(&self) -> bool

Return true if the workflow is replaying history events (excluding queries and update validators), false otherwise.

pub fn payload_converter(&self) -> &PayloadConverter

Returns the payload converter used by the worker running this workflow.

pub fn cancellation_token(&self) -> WorkflowCancellationToken

Return the workflow’s root cancellation token.

pub fn random_stream(&self, name: impl Into<String>) -> WorkflowRandomStream

Returns the deterministic pseudo-random stream associated with name.

Named streams let interceptors consume replay-safe randomness without changing the workflow’s default random sequence or another interceptor’s named sequence. Query and update-validator interceptors receive SyncWorkflowInterceptorContext, which does not expose random streams because those handlers are read-only.

pub fn timer<T>(&self, opts: T) -> impl CancellableFuture + use<T>

where T: Into<TimerOptions>,

Request to create a timer through the workflow outbound interceptor chain.

pub fn execute_activity<AD>( &self, activity: AD, input: impl Into<<AD as ActivityDefinition>::Input>, opts: ActivityOptions, ) -> impl CancellableFuture

where AD: ActivityDefinition, <AD as ActivityDefinition>::Output: TemporalDeserializable,

Request to run an activity through the workflow outbound interceptor chain.

pub fn execute_local_activity<AD>( &self, activity: AD, input: impl Into<<AD as ActivityDefinition>::Input>, opts: LocalActivityOptions, ) -> impl CancellableFuture

where AD: ActivityDefinition, <AD as ActivityDefinition>::Output: TemporalDeserializable,

Request to run a local activity through the workflow outbound interceptor chain.

pub fn start_child_workflow<WD>( &self, workflow: WD, input: impl Into<<WD as WorkflowDefinition>::Input>, opts: ChildWorkflowOptions, ) -> impl CancellableFutureWithReason

where WD: WorkflowDefinition + 'static, <WD as WorkflowDefinition>::Output: TemporalDeserializable,

Start a child workflow through the workflow outbound interceptor chain.

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

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

impl WorkflowInterceptorContext

pub fn start_nexus_operation( &self, opts: NexusOperationOptions, ) -> impl CancellableFuture

Start a Nexus operation through the workflow outbound interceptor chain.

Trait Implementations

impl Clone for WorkflowInterceptorContext

fn clone(&self) -> WorkflowInterceptorContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.