Skip to main content

LoopConfig

Struct LoopConfig 

Source
pub struct LoopConfig {
    pub counter: Option<String>,
    pub init: i64,
    pub increment: i64,
    pub max: i64,
    /* private fields */
}
Expand description

Engine-managed for loop over a workflow’s task list.

A workflow carrying a loop runs its task list repeatedly — one sweep per iteration — rather than once. Per sweep the engine writes the counter into temp_data (when counter names it), checks counter < max, then re-evaluates the workflow condition; the sweep runs only if both hold. Afterwards the counter advances by increment.

The bound is half-open, matching Rollout: init: 0, max: n yields counter values 0..n-1 — exactly array indices.

Reaching max is normal completion, never an error: max is always author-supplied, so hitting it is the stated bound rather than a runaway. To stop mid-body, use a filter task with on_reject: halt — that breaks the whole loop, not just the current sweep.

§Example

{
    "id": "per_item",
    "condition": {"<": [{"var": "temp_data.i"}, {"var": "temp_data.n"}]},
    "loop": { "counter": "i", "max": 10000 },
    "tasks": [ ... ]
}

Fields§

§counter: Option<String>

temp_data field the engine maintains as the induction variable — "i" means temp_data.i, and dot-paths nest ("cursor.index"temp_data.cursor.index).

None still bounds the loop by max; the count is simply not exposed to conditions or tasks. The engine tracks it either way, so the audit trail carries it regardless.

The engine owns this field: it is rewritten before every sweep, so a body task writing the same path is overwritten at the next increment.

§init: i64

First counter value. Defaults to 0.

§increment: i64

Added to the counter after each sweep. Defaults to 1; must be >= 1, so the counter strictly increases and the loop cannot stall.

§max: i64

Required upper bound — sweeps run while counter < max. There is no default: an unbounded loop is never what the author meant, and the bound is what makes termination structural rather than a property of the condition being written correctly.

Trait Implementations§

Source§

impl Clone for LoopConfig

Source§

fn clone(&self) -> LoopConfig

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 LoopConfig

Source§

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

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

impl<'de> Deserialize<'de> for LoopConfig

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 Eq for LoopConfig

Source§

impl PartialEq for LoopConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LoopConfig

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.