Expand description
The published contract of the embedded MADE.
This crate is what a consuming product is allowed to know. It holds plain views, a capability report, an error vocabulary and one trait — and no domain types, no adapters, no storage. A consumer that compiles against this crate alone can be tested with a stub and swapped onto any implementation that honours the same contract.
Versioned deliberately. CONTRACT_VERSION moves when the meaning of this
surface changes, independently of the library’s own release number: two
builds of the same release can differ in features, and a consumer that
guessed capabilities from a version string would find out mid-run. Consumers
check ApiCapabilities at startup instead.
Vocabulary note (ADR-001): these types speak the engine’s own language — ceremonies. A consuming product maps them to its own terms at its own boundary; nothing of that product’s vocabulary appears here.
Structs§
- ApiCapabilities
- What an implementation says it is and what it can do.
- Budget
Balance - Budget
Limits - Optional positive ceilings for a ceremony tree. At least one must be set.
An explicit zero is rejected; only
Noneleaves a dimension unlimited. - Budget
Quantities - Budget
Report - Budget
Reservation - Ceremony
Participant - One seat at a ceremony, as a consumer sees it.
- Ceremony
Summary - One ceremony instance, as a consumer sees it.
- Definition
Analysis View - What analysis found — all of it.
- Definition
Defect View - One defect found while analyzing a definition draft.
- Intervention
Response View - One answer given at the table.
- Intervention
View - One intervention — a question, investigation or proposed action put to the table — as a consumer sees it.
- Published
Definition View - A definition that is now published, or already was.
- Raise
Intervention Request - Request to put a question, investigation or proposed action to the table.
- Recalled
Entry View - One thing an earlier session left behind, as a consumer sees it.
- Recollection
View - What earlier sessions in a ceremony’s memory scope decided, as that ceremony was told when it opened.
- Respond
ToIntervention Request - Request to answer an open intervention.
- Start
Ceremony Request - Start a ceremony instance from a published definition.
Enums§
- ApiError
- How this contract fails.
Constants§
- CONTRACT_
VERSION - The revision of this contract.
Traits§
- Ceremony
Engine Api - What a consuming product may ask of the embedded engine.