Struct OutputDocument 

pub struct OutputDocument {
    pub kind: OutputDocumentKind,
    pub value: Value,
}

Optional semantic document attached to rendered output.

Fields

kind: OutputDocumentKind

Semantic payload identity.

value: Value

Canonical JSON substrate for the payload.

Implementations

impl OutputDocument

pub fn new(kind: OutputDocumentKind, value: Value) -> Self

Builds a semantic payload from its identity and canonical JSON value.

Examples

use osp_cli::core::output_model::{OutputDocument, OutputDocumentKind};
use serde_json::json;

let document = OutputDocument::new(OutputDocumentKind::Guide, json!({"title": "Help"}));

assert_eq!(document.kind, OutputDocumentKind::Guide);
assert_eq!(document.value["title"], "Help");

pub fn project_over_items(&self, items: &OutputItems) -> Self

Reprojects the payload over generic output items while keeping identity.

The canonical DSL uses this to preserve payload identity without branching on concrete semantic types inside the executor. Whether the projected JSON still restores into the original payload kind is decided later by the payload codec, not by the pipeline engine itself.

Examples

use osp_cli::core::output_model::{OutputDocument, OutputDocumentKind, OutputItems};
use osp_cli::row;
use serde_json::json;

let document = OutputDocument::new(OutputDocumentKind::Guide, json!({"usage": ["osp"]}));
let projected = document.project_over_items(&OutputItems::Rows(vec![
    row! { "uid" => "alice" },
]));

assert_eq!(projected.kind, OutputDocumentKind::Guide);
assert_eq!(projected.value["uid"], "alice");

Trait Implementations

impl Clone for OutputDocument

fn clone(&self) -> OutputDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputDocument

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

Formats the value using the given formatter.

impl PartialEq for OutputDocument

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OutputDocument