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