Skip to main content

Module contract

Module contract 

Source
Expand description

Versioned JSON result-contract types shared by CLI and embedded producers.

The CLI is one producer of these envelopes. Embedded pipelines can use the same constructors and immutable protocol identities without duplicating the wire shape or hard-coding URNs.

Structs§

DiffEnvelope
Current diff-command result envelope.
InputIdentity
Immutable identity of the bytes used to produce one file report.
LintEnvelope
Immutable historical output-v15 lint envelope.
LintEnvelopeV16
Current output-v16 lint envelope.
LintEnvelopeV17
Current output-v17 lint envelope.
LintFileReport
Current output-v15 lint file evidence with correlated V3 or V4 prediction provenance.
LintFileReportV16
Current output-v16 lint file evidence with V3 or V5 prediction provenance.
LintFileReportV17
Current output-v17 lint file evidence with immutable V3, V5, or V6 provenance.
MeasureEnvelope
Current measure-command result envelope.
MeasureFileReport
One source file and its measurement-command evidence.
MeasurementContract
Independently versioned measurement payload nested in measure and lint file records.
MeasurementReportFile
One validated file record recovered from a measurement report.
MeasurementReportInput
Typed read-side subset accepted when a consumer needs measurements from a current measure or lint report.
RigInfo
Rig profile and resolved semantic-role bindings for one input file.
ToolInfo
Identity of the animsmith producer that emitted an envelope.
ToolSource
Source checkout identity for the producing animsmith build.

Enums§

MeasurementContractError
Measurement evidence could not satisfy the current measurement contract.
MeasurementFileError
One measurement-report file record failed validation.
MeasurementReportError
A typed measurement-report subset failed current-contract validation.
MeasurementReportReadError
A serialized output-v11 report could not be read within the public bound.
OutputContractError
A producer attempted to construct output outside the immutable v11 contract.
RigInfoError
Resolved-role evidence did not belong to the supplied document.

Constants§

MEASUREMENTS_SCHEMA_ID
Immutable identity of the current nested measurement contract.
MEASUREMENTS_SCHEMA_VERSION
Current nested measurement-contract version.
MEASUREMENTS_V15_SCHEMA_ID
Immutable measurements-v15 identity retained for output-v11 and output-v12 readers.
MEASUREMENTS_V15_SCHEMA_VERSION
Immutable measurements-v15 version retained for historical report readers.
OUTPUT_SCHEMA_ID
Immutable identity of the current outer result envelope.
OUTPUT_SCHEMA_VERSION
Current outer result-envelope version.
OUTPUT_V10_SCHEMA_ID
Immutable output-v10 identity retained by V1 dependent contracts.
OUTPUT_V11_MAX_CHECKS_PER_FILE
Maximum check records carried by one output-v11 lint file.
OUTPUT_V11_MAX_FILES
Maximum file records carried by one output-v11 envelope.
OUTPUT_V11_MAX_REPORT_BYTES
Maximum serialized bytes accepted by the output-v11 report reader.
OUTPUT_V11_SCHEMA_ID
Immutable output-v11 identity retained as historical schema evidence.
OUTPUT_V11_SCHEMA_VERSION
Immutable output-v11 version retained as historical schema evidence.
OUTPUT_V12_SCHEMA_ID
Immutable identity of the bounded-overflow outer result envelope.
OUTPUT_V12_SCHEMA_VERSION
Schema version of output-v12.
OUTPUT_V13_SCHEMA_ID
Immutable output-v13 identity retained as historical V2 prediction evidence.
OUTPUT_V13_SCHEMA_VERSION
Schema version of output-v13.
OUTPUT_V14_SCHEMA_ID
Immutable output-v14 identity retained for historical V3 prediction evidence.
OUTPUT_V14_SCHEMA_VERSION
Schema version of output-v14.
OUTPUT_V15_SCHEMA_ID
Immutable output-v15 identity retained for historical V4 prediction evidence.
OUTPUT_V15_SCHEMA_VERSION
Schema version of output-v15.
OUTPUT_V16_SCHEMA_ID
Immutable output-v16 identity retained for historical V5 prediction evidence.
OUTPUT_V16_SCHEMA_VERSION
Schema version of output-v16.

Functions§

sha256_hex
Lowercase hexadecimal SHA-256 digest of exactly these bytes.