reference

`labkit.app.result.File`

Declare one validated result-package output.

Syntax

output = labkit.app.result.File(id, role, relativePath, Name=Value)

Description

File records App-owned output identity and media semantics. Runtime result writing later resolves the relative path, file size, checksum, and aggregate manifest status.

Inputs

id: Nonempty scalar text unique within one Result.
role: Nonempty scalar text describing output purpose.
relativePath: Nonempty package-relative path without traversal.

Optional Name-Value Arguments

MediaType: Nonempty media-type scalar text. Default: "application/octet-stream".
Status: "success", "failed", or "skipped". Default: "success".
Message: Scalar reader-facing status text. Default: empty.
Warnings: Row string or cellstr array. Default: empty.

Outputs

output: Immutable labkit.app.result.File value.

Errors

labkit:app:contract:UnknownArgument: An option is unknown, duplicated, or unpaired.
labkit:app:contract:InvalidValue: Text, path, status, or warnings are malformed.

Example

output = labkit.app.result.File( ...
"summary", "primary", "summary.csv", MediaType="text/csv");
assert(output.Status == "success")

labkit.app.result.Package — Declare one App-owned result manifest request.
labkit.app.CallbackContext — Provide declared App-neutral runtime capabilities.

Source

This page is generated from the MATLAB help text in +labkit/+app/+result/File.m.

labkit.app.result.File