Struct WorkflowOptions 

pub struct WorkflowOptions {
    pub allow_failure: bool,
    /* private fields */
}

Options of a sub-workflow step started with workflow_with.

Examples

use ironflow_engine::config::WorkflowOptions;

let options = WorkflowOptions::new().allow_failure();
assert!(options.allow_failure);
assert!(!WorkflowOptions::default().allow_failure);

Fields

allow_failure: bool

Tolerate a failed child run instead of failing the parent.

Implementations

impl WorkflowOptions

pub fn new() -> Self

Create options with every flag off.

Examples

use ironflow_engine::config::WorkflowOptions;

assert_eq!(WorkflowOptions::new(), WorkflowOptions::default());

pub fn allow_failure(self) -> Self

Tolerate a failed child run: the step completes with the failure in its output and the parent run ends as Warning. A suspension is never tolerated.

Examples

use ironflow_engine::config::WorkflowOptions;

assert!(WorkflowOptions::new().allow_failure().allow_failure);

pub fn concurrency_key(self, key: impl Into<String>) -> Self

Make the child run exclusive on key.

While another non-terminal run (Pending, Running, Retrying, Sleeping, AwaitingApproval) holds the same key, no child run is created and the step completes with a SubWorkflowOutcome::Conflict.

Panics

Panics if key is empty or only whitespace, or longer than MAX_CONCURRENCY_KEY_LEN bytes.

Examples

use ironflow_engine::config::WorkflowOptions;

let options = WorkflowOptions::new().concurrency_key("issue:12");
assert_eq!(options.concurrency_key_ref(), Some("issue:12"));

use ironflow_engine::config::WorkflowOptions;

WorkflowOptions::new().concurrency_key("  ");

pub fn concurrency_key_ref(&self) -> Option<&str>

The concurrency key, if one was set.

Examples

use ironflow_engine::config::WorkflowOptions;

let options = WorkflowOptions::new().concurrency_key("deploy:prod");
assert_eq!(options.concurrency_key_ref(), Some("deploy:prod"));

pub fn priority(self, priority: i16) -> Self

Set the queue priority of the child run, overriding the priority of the child handler.

The child executes inside its parent’s worker; the priority is recorded on the child run and orders it whenever it waits in the queue.

Panics

Panics if priority is outside MIN_PRIORITY..=MAX_PRIORITY.

Examples

use ironflow_engine::config::WorkflowOptions;

let options = WorkflowOptions::new().priority(20);
assert_eq!(options.priority_ref(), Some(20));

use ironflow_engine::config::WorkflowOptions;

WorkflowOptions::new().priority(101);

pub fn priority_ref(&self) -> Option<i16>

The priority of the child run, if one was set.

Examples

use ironflow_engine::config::WorkflowOptions;

assert_eq!(WorkflowOptions::new().priority_ref(), None);
assert_eq!(WorkflowOptions::new().priority(-5).priority_ref(), Some(-5));

Trait Implementations

impl Clone for WorkflowOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowOptions

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

Formats the value using the given formatter.

impl Default for WorkflowOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for WorkflowOptions

impl PartialEq for WorkflowOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WorkflowOptions