Skip to main content

Module output_model

Module output_model 

Source
Expand description

Structured row/group/document output types. Structured output payload model shared across commands, DSL stages, and UI.

This module exists to keep command results in a small canonical shape while they move between execution, transformation, and rendering layers.

High-level flow:

Contract:

  • this module describes data shape, not rendering policy
  • semantic sidecar documents should stay canonical here instead of leaking format-specific assumptions into the DSL or UI

Structs§

Group
Grouped output with grouping keys, aggregate values, and member rows.
OutputDocument
Optional semantic document attached to rendered output.
OutputMeta
Rendering metadata attached to an OutputResult.
OutputResult
Structured command output plus rendering metadata.

Enums§

ColumnAlignment
Alignment hint for a rendered output column.
OutputDocumentKind
Stable identity for a semantic payload carried through the output pipeline.
OutputItems
Result payload as either flat rows or grouped rows.
RenderRecommendation
Suggested render target for a command result.

Functions§

compute_key_index
Computes the stable first-seen column order across all rows.
output_items_from_value
Projects a canonical JSON value back into generic output items.
output_items_to_value
Projects output items into a canonical JSON value.
rows_from_value
Projects any JSON value into a row stream for pipeline-oriented processing.