made-api 0.7.2

Published contract of the embedded MADE: versioned views, capabilities and errors
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//! 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.

mod api_capabilities;
mod api_error;
mod authoring_views;
mod budget_balance;
mod budget_limits;
mod budget_quantities;
mod budget_report;
mod budget_reservation;
mod ceremony_engine_api;
mod ceremony_participant;
mod ceremony_summary;
mod definition_defect_view;
mod intervention_response_view;
mod intervention_views;
mod published_definition_view;
mod raise_intervention_request;
mod recalled_entry_view;
mod recollection_view;
mod respond_to_intervention_request;
mod start_ceremony_request;

pub use api_capabilities::ApiCapabilities;
pub use api_error::ApiError;
pub use authoring_views::DefinitionAnalysisView;
pub use budget_balance::BudgetBalance;
pub use budget_limits::BudgetLimits;
pub use budget_quantities::BudgetQuantities;
pub use budget_report::BudgetReport;
pub use budget_reservation::BudgetReservation;
pub use ceremony_engine_api::CeremonyEngineApi;
pub use ceremony_participant::CeremonyParticipant;
pub use ceremony_summary::CeremonySummary;
pub use definition_defect_view::DefinitionDefectView;
pub use intervention_response_view::InterventionResponseView;
pub use intervention_views::InterventionView;
pub use published_definition_view::PublishedDefinitionView;
pub use raise_intervention_request::RaiseInterventionRequest;
pub use recalled_entry_view::RecalledEntryView;
pub use recollection_view::RecollectionView;
pub use respond_to_intervention_request::RespondToInterventionRequest;
pub use start_ceremony_request::StartCeremonyRequest;

/// The revision of this contract.
///
/// Moves on meaning, not on release: adding a capability keeps the version,
/// changing what an existing field or method means raises it.
pub const CONTRACT_VERSION: u32 = 3;