Struct WfContext 

pub struct WfContext { /* private fields */ }

Used within workflows to issue commands, get info, etc.

Implementations

impl WfContext

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 get_args(&self) -> &[Payload]

Get the arguments provided to the workflow upon execution start

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 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 async fn cancelled(&self) -> String

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

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

Request to create a timer

pub fn activity( &self, opts: ActivityOptions, ) -> impl CancellableFuture<ActivityResolution>

Request to run an activity

pub fn local_activity( &self, opts: LocalActivityOptions, ) -> impl CancellableFuture<ActivityResolution> + '_

Request to run a local activity

pub fn child_workflow(&self, opts: ChildWorkflowOptions) -> ChildWorkflow

Creates a child workflow stub with the provided options

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 signal_workflow( &self, opts: impl Into<SignalWorkflowOptions>, ) -> impl CancellableFuture<SignalExternalWfResult>

Send a signal to an external workflow. May resolve as a failure if the signal didn’t work or was cancelled.

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 make_signal_channel( &self, signal_name: impl Into<String>, ) -> DrainableSignalStream

Return a stream that produces values when the named signal is sent to this workflow

pub fn force_task_fail(&self, with: Error)

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

pub fn cancel_external( &self, target: NamespacedWorkflowExecution, reason: String, ) -> impl Future<Output = CancelExternalWfResult>

Request the cancellation of an external workflow. May resolve as a failure if the workflow was not found or the cancel was otherwise unsendable.

pub fn update_handler<Arg, Res>( &self, name: impl Into<String>, validator: impl IntoUpdateValidatorFunc<Arg>, handler: impl IntoUpdateHandlerFunc<Arg, Res>, )

Register an update handler by providing the handler name, a validator function, and an update handler. The validator must not mutate workflow state and is synchronous. The handler may mutate workflow state (though, that’s annoying right now in the prototype) and is async.

Note that if you want a validator that always passes, you will likely need to provide type annotations to make the compiler happy, like: |_: &_, _: T| Ok(())

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

Start a nexus operation

pub fn wait_condition( &self, condition: impl FnMut() -> bool, ) -> impl Future<Output = ()>

Wait for some condition to become true, yielding the workflow if it is not.

Trait Implementations

impl Clone for WfContext

fn clone(&self) -> WfContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.