Skip to main content

canic_core/api/
mod.rs

1//! Module: api
2//!
3//! Responsibility: public API facades for macro-generated canister endpoints.
4//! Does not own: orchestration, business logic, policy, or storage invariants.
5//! Boundary: maps endpoint calls into workflow calls and public errors.
6
7pub mod auth;
8#[cfg(feature = "blob-storage")]
9pub mod blob_storage;
10pub mod call;
11pub mod cascade;
12pub mod config;
13pub mod error;
14pub mod ic;
15pub mod icp_refill;
16pub mod intent;
17pub mod lifecycle;
18pub mod memory;
19pub mod metadata;
20pub mod placement;
21pub mod pool;
22pub mod ready;
23pub mod rpc;
24pub mod runtime;
25pub mod state;
26pub mod timer;
27pub mod topology;
28
29///
30/// Read-only query re-exports
31///
32/// Only queries that satisfy ALL of the following may be re-exported directly:
33///
34/// - Read-only
35/// - No orchestration or side effects
36/// - No policy or invariant enforcement
37/// - No internal `InternalError` in public signatures
38/// - Return DTOs or primitives only
39///
40/// Queries that can fail with internal errors or enforce invariants
41/// MUST be wrapped in an API façade instead.
42///
43
44pub mod cycles {
45    pub use crate::workflow::runtime::cycles::query::CycleTrackerQuery;
46}
47pub mod env {
48    pub use crate::workflow::env::query::EnvQuery;
49}
50pub mod icrc {
51    pub use crate::workflow::icrc::query::{Icrc10Query, Icrc21Query};
52}
53pub mod log {
54    pub use crate::workflow::log::query::LogQuery;
55}
56pub mod metrics {
57    pub use crate::workflow::metrics::query::MetricsQuery;
58}