Skip to main content

FoldSpec

Struct FoldSpec 

Source
pub struct FoldSpec { /* private fields */ }
Expand description

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

Implementations§

Source§

impl FoldSpec

Source

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.

Source

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.

Source

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§

Source§

impl Clone for FoldSpec

Source§

fn clone(&self) -> FoldSpec

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 FoldSpec

Source§

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

Formats the value using the given formatter. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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.