Skip to main content

ExecutionResult

Struct ExecutionResult 

Source
pub struct ExecutionResult {
    pub proceed: bool,
    pub outcome_value: Option<Value>,
    pub sleep_for: Option<Duration>,
    pub persistence_data: Option<Value>,
    pub event_name: Option<String>,
    pub event_key: Option<String>,
    pub event_as_of: Option<DateTime<Utc>>,
    pub branch_values: Option<Vec<Value>>,
    pub poll_endpoint: Option<PollEndpointConfig>,
    pub output_data: Option<Value>,
}
Expand description

The result returned by a step’s run method.

ExecutionResult controls what the executor does next: proceed, branch, sleep, wait for an event, or persist state for the next execution.

Fields§

§proceed: bool

Whether the workflow should proceed to the next step.

§outcome_value: Option<Value>

Outcome value for decision-based routing.

§sleep_for: Option<Duration>

Duration to sleep before re-executing.

§persistence_data: Option<Value>

Step-specific state to persist between executions.

§event_name: Option<String>

Event name to wait for.

§event_key: Option<String>

Event key to match.

§event_as_of: Option<DateTime<Utc>>

Only consider events published after this time.

§branch_values: Option<Vec<Value>>

Values to branch execution on (for ForEach/Parallel).

§poll_endpoint: Option<PollEndpointConfig>

Poll endpoint configuration for external service polling.

§output_data: Option<Value>

Output data to merge into workflow.data after step completion.

Implementations§

Source§

impl ExecutionResult

Source

pub fn next() -> Self

Continue to the next step.

Source

pub fn outcome(value: impl Into<Value>) -> Self

Continue with an outcome value for decision routing.

Source

pub fn persist(data: Value) -> Self

Pause execution and persist step-specific data.

Source

pub fn branch(values: Vec<Value>, persistence_data: Option<Value>) -> Self

Create child branches for parallel/foreach execution.

Source

pub fn sleep(duration: Duration, persistence_data: Option<Value>) -> Self

Sleep for a duration before re-executing.

Source

pub fn wait_for_event( event_name: impl Into<String>, event_key: impl Into<String>, as_of: DateTime<Utc>, ) -> Self

Wait for an external event.

Source

pub fn poll_endpoint(config: PollEndpointConfig) -> Self

Poll an external endpoint until a condition is met.

Trait Implementations§

Source§

impl Clone for ExecutionResult

Source§

fn clone(&self) -> ExecutionResult

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExecutionResult

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ExecutionResult

Source§

fn default() -> ExecutionResult

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ExecutionResult

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ExecutionResult

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> WorkflowData for T
where T: Serialize + DeserializeOwned + Send + Sync + Clone + 'static,