Skip to main content

PAYLOAD_SCHEMA

Constant PAYLOAD_SCHEMA 

Source
pub const PAYLOAD_SCHEMA: u32 = 2;
Expand description

The version of the manifest’s shape and of the bundle protocol.

The one number an engine compares before it reads a bundle. The constant is declared with this exact spelling because a bundle’s own copy is read back out of its sources by dir::declared_schema.

Schema 2 adds GLOSSARY.md to the destinations a landing writes. The number moves because an engine that projects only the schema-1 destinations would land a routing block naming a file it never writes, which no declaration inside the bundle can prevent: the projection is the engine’s own code. An engine reads every schema at or below this number, so a schema-1 bundle stays readable here and a schema-1 engine refuses this bundle naming the version to install.