Skip to main content

WorkflowContext

Struct WorkflowContext 

Source
pub struct WorkflowContext<'a> { /* private fields */ }
Expand description

Replay helper for Rust workflow runtimes.

WorkflowContext is a read-only view over a workflow invocation. It provides deterministic helpers for inspecting persisted history and returning the next command to the engine.

Implementations§

Source§

impl<'a> WorkflowContext<'a>

Source

pub fn new(invocation: &'a WorkflowInvocation) -> Self

Source

pub fn run_id(&self) -> &str

Source

pub fn input(&self) -> &JsonValue

Source

pub fn input_as<T>(&self) -> Result<T>

Decode the workflow input into a host-defined serde type.

Source

pub fn history(&self) -> &[FlowEventEnvelope]

Source

pub fn step_output(&self, step_id: &str) -> Option<&JsonValue>

Source

pub fn step_output_as<T>(&self, step_id: &str) -> Result<Option<T>>

Source

pub fn step_completed(&self, step_id: &str) -> bool

Source

pub fn step_failed(&self, step_id: &str) -> Option<&str>

Source

pub fn wait_completed(&self, wait_id: &str) -> bool

Source

pub fn hook_payload(&self, hook_id: &str) -> Option<&JsonValue>

Source

pub fn hook_payload_as<T>(&self, hook_id: &str) -> Result<Option<T>>

Source

pub fn hook_disposed(&self, hook_id: &str) -> bool

Source

pub fn complete(&self, output: JsonValue) -> RuntimeCommand

Source

pub fn fail(&self, error: impl Into<String>) -> RuntimeCommand

Source

pub fn schedule_step( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, ) -> RuntimeCommand

Source

pub fn schedule_step_with_retry( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, retry: RetryPolicy, ) -> RuntimeCommand

Source

pub fn step( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, ) -> StepCommand

Source

pub fn step_with_retry( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, retry: RetryPolicy, ) -> StepCommand

Source

pub fn schedule_steps(&self, steps: Vec<StepCommand>) -> RuntimeCommand

Source

pub fn wait_until( &self, wait_id: impl Into<String>, resume_at: DateTime<Utc>, ) -> RuntimeCommand

Source

pub fn create_hook( &self, hook_id: impl Into<String>, token: impl Into<String>, metadata: JsonValue, ) -> RuntimeCommand

Source

pub fn create_hook_with_metadata( &self, hook_id: impl Into<String>, token: impl Into<String>, metadata: HookMetadata, ) -> Result<RuntimeCommand>

Auto Trait Implementations§

§

impl<'a> Freeze for WorkflowContext<'a>

§

impl<'a> RefUnwindSafe for WorkflowContext<'a>

§

impl<'a> Send for WorkflowContext<'a>

§

impl<'a> Sync for WorkflowContext<'a>

§

impl<'a> Unpin for WorkflowContext<'a>

§

impl<'a> UnsafeUnpin for WorkflowContext<'a>

§

impl<'a> UnwindSafe for WorkflowContext<'a>

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