Skip to content

Commit eaae72d

Browse files
committed
Order hint metadata for input and output nodes.
1 parent 68415f4 commit eaae72d

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

hugr-model/src/v0/mod.rs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,26 @@ pub const COMPAT_CONST_JSON: &str = "compat.const_json";
278278
/// - **Result:** `core.meta`
279279
pub const ORDER_HINT_KEY: &str = "core.order_hint.key";
280280

281+
/// Metadata constructor for order hint keys on input nodes.
282+
///
283+
/// When the sources of a dataflow region are represented by an input operation
284+
/// within the region, this metadata can be attached the region to give the
285+
/// input node an order hint key.
286+
///
287+
/// - **Parameter:** `?key : core.nat`
288+
/// - **Result:** `core.meta`
289+
pub const ORDER_HINT_INPUT_KEY: &str = "core.order_hint.input_key";
290+
291+
/// Metadata constructor for order hint keys on output nodes.
292+
///
293+
/// When the targets of a dataflow region are represented by an output operation
294+
/// within the region, this metadata can be attached the region to give the
295+
/// output node an order hint key.
296+
///
297+
/// - **Parameter:** `?key : core.nat`
298+
/// - **Result:** `core.meta`
299+
pub const ORDER_HINT_OUTPUT_KEY: &str = "core.order_hint.output_key";
300+
281301
/// Metadata constructor for order hints.
282302
///
283303
/// When this metadata is attached to a dataflow region, it can indicate a

0 commit comments

Comments
 (0)