Struct SubFlowOptions 

pub struct SubFlowOptions { /* private fields */ }

Configures one durable SubFlow Condition.

Changed in 1.25.0: the SubFlow always selects pull Workers. Other omitted configuration fields inherit the parent’s effective settings. Dex generates its Flow ID and request ID. Builder methods preserve normal Flow start defaults when omitted. Matching generated request IDs always attach to an existing child, regardless of reuse policy. For different request IDs, the reuse policy decides whether to attach or restart. Completing an any-of wait does not stop non-winning SubFlows; use their generated Flow IDs with crate::Client::stop_flow when those children should stop.

Implementations

impl SubFlowOptions

pub fn new() -> Self

Creates options using the abnormal-restart reuse policy and normal start defaults.

pub fn timeout(self, value: Duration) -> Self

Sets the maximum total SubFlow execution duration.

pub fn timeout_policy(self, value: FlowTimeoutPolicy) -> Self

Selects what Dex does when the positive soft SubFlow timeout expires.

pub fn timeout_handler_options(self, value: FlowTimeoutHandlerOptions) -> Self

Configures execution and selective state loading for the target Flow’s timeout handler.

pub fn start_delay(self, value: Duration) -> Self

Sets a delay before the SubFlow starting Step after server acceptance.

The Server currently supports only a zero delay. It rejects a Step result that requests a SubFlow with a positive delay as invalid input, so that Step attempt fails.

pub fn retry_policy(self, value: RetryPolicy) -> Self

Sets a whole-Flow retry policy for the SubFlow.

The Server does not support whole-Flow retry. It rejects a Step result that requests a SubFlow with this option as invalid input, so that Step attempt fails. Configure crate::RetryPolicy on the SubFlow’s Step methods through crate::StepOptions instead.

pub fn config_override(self, value: FlowConfig) -> Self

Applies fields over the inherited parent Flow configuration.

pub fn reuse_policy(self, value: SubFlowReusePolicy) -> Self

Selects existing-execution resolution behavior.

pub fn condition_id(self, value: impl Into<String>) -> Self

Assigns the stable ID required by crate::Wait::any_combination_of.

pub fn initial_attribute<T: Value>( self, attribute: &Attribute<T>, value: T, ) -> Self

Adds one initial singleton Attribute owned by the target SubFlow.

pub fn initial_attribute_map<T: Value>( self, attribute: &AttributeMap<T>, instance: &str, value: T, ) -> Self

Adds one initial Attribute-map value for an instance. Slash is prohibited in instance keys because it is a reserved character.

Trait Implementations

impl Clone for SubFlowOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SubFlowOptions

fn default() -> Self

Returns the “default value” for a type.