Enum OnBound 

pub enum OnBound {
    Join,
    Fail,
}

What a FoldNode reaching its iteration bound means, when stop_when never held.

A bare lowercase string on the wire ("join", "fail"), not the adjacently tagged shape FoldJoin uses: the two variants carry no data and none is foreseen, so a tag object would be ceremony around a word. Adding a third variant later stays additive all the same, because an older document simply omits the field.

Absent means OnBound::Join, which is what every fold written before this field existed does, so the default is the behavior already shipped rather than a new one chosen now. Authors reach for OnBound::Fail when the stop predicate is a REQUIREMENT rather than an early exit: a loop that must reach a score before its value is worth anything is better off saying so than handing a caller the best of several passes that all fell short. Data only; this crate never runs the loop, and the engine reads this field in a later slice.

Variants

Join

Reaching the bound joins the passes exactly as stop_when holding would: the join rule picks the value the node produces. Today’s behavior, and what an absent field means.

Fail

Reaching the bound without stop_when holding is an error: the loop converged on nothing, and the node produces no value.

Trait Implementations

impl Clone for OnBound

fn clone(&self) -> OnBound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OnBound

impl Debug for OnBound

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OnBound

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OnBound

impl JsonSchema for OnBound

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for OnBound

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OnBound

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OnBound