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
Current lint-command result envelope.
LintFileReport
One source file and its lint-command evidence.
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-v10 report could not be read within the public bound.
OutputContractError
A producer attempted to construct output outside the immutable v10 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.
OUTPUT_SCHEMA_ID
Immutable identity of the current outer result envelope.
OUTPUT_SCHEMA_VERSION
Current outer result-envelope version.
OUTPUT_V10_MAX_CHECKS_PER_FILE
Maximum check records carried by one output-v10 lint file.
OUTPUT_V10_MAX_FILES
Maximum file records carried by one output-v10 envelope.
OUTPUT_V10_MAX_REPORT_BYTES
Maximum serialized bytes accepted by the output-v10 report reader.

Functions§

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