Compare

typed block

Allows comparisons against the specified value.

Factories

`Compare`

Compare() -> CompareHandle

Construct a fresh Compare block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`Compare`

Compare(id: String) -> CompareHandle

Construct a Compare block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`comparison_value`

comparison_value(value: JSONPath) -> CompareHandle

Set the ComparisonValue parameter. Any single JSONPath identifier that is valid for the flow data object. Measured 2026-10-14: Connect refuses a literal, a number, the empty string and a path outside the parameter_value grammar.

Parameter	Type	Required	Description
`value`	`JSONPath`	yes	Any single JSONPath identifier that is valid for the flow data object. Measured 2026-10-14: Connect refuses a literal, a number, the empty string and a path outside the `parameter_value` grammar.

`next`

next(target: Handle) -> CompareHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`when`

when(cond: ConditionHandle, target: Handle) -> CompareHandle

Append a Conditions[] branch. Multiple .when(...) calls chain, evaluation runs in source order, first match wins.

Parameter	Type	Required	Description
`cond`	`ConditionHandle`	yes	Built from the `Cond::<op>(...)` namespace, e.g. `Cond::equals("42")`.
`target`	`Handle`	yes	Block to route to when the condition matches.

`on_no_matching_condition`

on_no_matching_condition(target: Handle) -> CompareHandle

Wire an error transition for NoMatchingCondition: if no other Condition matches.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingCondition`. if no other Condition matches.

`set_id`

set_id(id: String) -> CompareHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> CompareHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> CompareHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> CompareHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> CompareHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> CompareHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> CompareHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> CompareHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).