labkit.app.result.Package

Description

Result contains validated output declarations and App-owned input, parameter, and summary data. Runtime result writing owns provenance, App and facade versions, document identity, file bytes, checksums, creation identity/time, aggregate status, and atomic replacement.

Required Name-Value Arguments

Outputs

Nonempty row cell array of labkit.app.result.File values with unique IDs and relative paths and at least one success.

Inputs

Scalar App-owned struct describing result inputs.

Parameters

Scalar App-owned struct describing result parameters.

Summary

Scalar App-owned struct describing result summary.

Optional Name-Value Arguments

Warnings

Row string or cellstr array. Default: empty.

ManifestName

Nonempty filename without folders. Default: "labkit_result.json".

Outputs

result

Immutable labkit.app.result.Package value.

Errors

labkit:app:contract:UnknownArgument

An option is missing, unknown, duplicated, or unpaired.

labkit:app:contract:InvalidValue

A value or manifest name is invalid.

labkit:app:contract:DuplicateId

Output IDs or paths repeat.

Example

output = labkit.app.result.File( ...
"summary", "primary", "summary.csv", MediaType="text/csv");
result = labkit.app.result.Package(Outputs={output}, Inputs=struct(), ...
Parameters=struct(), Summary=struct("rows", 1));
assert(result.ManifestName == "labkit_result.json")