Struct FoldSpec 

pub struct FoldSpec { /* private fields */ }

The spec for a fold node: bounded iteration that accumulates across passes.

Implementations

impl FoldSpec

pub fn new( id: impl Into<String>, body: FoldBody, max_iterations: u32, stop_when: impl Into<String>, join: FoldJoin, ) -> Self

Starts a fold spec with its required fields: the node id, the FoldBody each pass runs, the iteration bound, the stop_when predicate, and the FoldJoin rule. The bound’s positivity, the predicate’s parse, and a best_by reference’s shape are checked by [crate::validate], not here.

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

Sets a short display label for this node. Bounds (a 64-character cap, not empty or all whitespace) are checked by [crate::validate], not here; see crate::document’s “The optional node display name” section for why this field, unlike an agent’s own name, is part of the graph’s content hash.

pub fn on_bound(self, on_bound: OnBound) -> Self

Declares what a reached iteration bound means. Left unset, the field stays off the wire and the fold means OnBound::Join, which is what a fold written before the field existed does; set it to OnBound::Fail when the stop predicate is a requirement rather than an early exit.

pub fn accumulator_schema(self, schema: Value) -> Self

Declares the JSON Schema for the accumulated value the loop carries and produces. Data only, like an agent’s output_schema.

Trait Implementations

impl Clone for FoldSpec

fn clone(&self) -> FoldSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoldSpec

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

Formats the value using the given formatter.