Skip to main content

StepExecutionContext

Struct StepExecutionContext 

Source
pub struct StepExecutionContext<'a> {
Show 13 fields pub item: Option<&'a Value>, pub execution_pointer: &'a ExecutionPointer, pub persistence_data: Option<&'a Value>, pub step: &'a WorkflowStep, pub workflow: &'a WorkflowInstance, pub definition: Option<&'a WorkflowDefinition>, pub cancellation_token: CancellationToken, pub host_context: Option<&'a dyn HostContext>, pub log_sink: Option<&'a dyn LogSink>, pub artifact_store: Option<&'a dyn ArtifactStore>, pub artifact_volume: Option<&'a ArtifactVolume>, pub artifact_package: Option<ArtifactVolumePackage>, pub persistence: Option<&'a dyn PersistenceProvider>,
}
Expand description

Context available to a step during execution.

Fields§

§item: Option<&'a Value>

The current item when iterating (ForEach).

§execution_pointer: &'a ExecutionPointer

The current execution pointer.

§persistence_data: Option<&'a Value>

Persistence data from a previous execution of this step.

§step: &'a WorkflowStep

The step definition.

§workflow: &'a WorkflowInstance

The running workflow instance.

§definition: Option<&'a WorkflowDefinition>

The compiled workflow definition the instance was created from. None on code paths that don’t have it available (some test fixtures); production execution always populates this so executor-specific features (e.g. Kubernetes shared volumes) can inspect the definition-level configuration.

§cancellation_token: CancellationToken

Cancellation token.

§host_context: Option<&'a dyn HostContext>

Host context for starting child workflows. None if not available.

§log_sink: Option<&'a dyn LogSink>

Log sink for streaming step output. None if not configured.

§artifact_store: Option<&'a dyn ArtifactStore>

Artifact store for backward compatibility.

§artifact_volume: Option<&'a ArtifactVolume>

Resolved artifact volume for this step. Preferred over artifact_store.

§artifact_package: Option<ArtifactVolumePackage>

Serialized artifact package for distributed scenarios.

§persistence: Option<&'a dyn PersistenceProvider>

Persistence provider. Available to long-running steps (e.g. SignAndWriteCommitStep) that need to emit a mid-step heartbeat by calling persistence.persist_workflow(&instance). The Postgres implementation automatically bumps last_heartbeat_at = now() on every persist_workflow call.

Trait Implementations§

Source§

impl<'a> Debug for StepExecutionContext<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more