Skip to main content

Module declared

Module declared 

Source
Expand description

What a bundle declares beyond its bytes: the compatibility file and the guidance files, read through the seam and parsed once.

compatibility.toml is small by design. A bundle that carries none declares no requirement beyond the payload schema, which is what Compatibility::default says. A guidance file is one release’s operator step, named by the version that introduces it and carrying the destinations it concerns, so the planner can filter it against a target.

Structs§

Compatibility
What the bundle needs beyond the payload schema.
Engine
The engine axis: the oldest engine that may land this bundle.
Floor
One forge’s version floor.
GuidanceDecl
The guidance coverage the bundle claims.
GuidanceFile
One release’s guidance, parsed.
Intermediate
One release a landing must pass through.

Constants§

COMPATIBILITY_PATH
The compatibility file’s path inside a bundle.
GUIDANCE_ACTIONS
The closed set of actions a guidance file may name.
GUIDANCE_ROOT
The guidance root inside a bundle.

Functions§

carries_guidance
Whether the bundle carries a guidance root at all. A bundle from before the root existed carries none, and its history is unavailable rather than empty.
compatibility
Read the compatibility file through the seam, or the default where the bundle carries none.
guidance
Every guidance file the bundle carries, parsed, sorted by version.
parse_compatibility
Parse the compatibility file’s text.
parse_guidance
Parse one guidance file.
version_below
Whether a is below b, as versions. Text that is not a version compares as not below, so an unreadable value never passes a floor.
version_key
A version as a comparable key: the numeric components, with a leading v and any pre-release or build suffix dropped. None for text with no leading number.