canic_core/
lib.rs

1//! Core Canic library used inside canisters.
2//!
3//! Most users should depend on the `canic` facade crate, which re-exports this crate
4//! under `canic::core` and exposes the common entrypoint macros:
5//! - `canic::build!` / `canic::build_root!` (in `build.rs`) to validate/embed `canic.toml`
6//! - `canic::start!` / `canic::start_root!` (in `lib.rs`) to wire lifecycle hooks and export endpoints
7//!
8//! ## Layering
9//!
10//! Canic is organized to keep endpoint code thin and policies centralized:
11//! - `access/` contains guard/auth/rule helpers for boundary enforcement.
12//! - `workflow/` implements orchestration and lifecycle workflows.
13//! - `policy/` owns deterministic decision rules.
14//! - `ops/` provides mechanical, reusable side-effecting operations.
15//! - `model/` owns storage (stable memory) and in-process registries/caches.
16//! - macro entrypoints live in the `canic` facade crate.
17//!
18//! The default flow is: endpoints → workflow → policy → ops → model.
19
20// -----------------------------------------------------------------------------
21// Phase 0: path coherence re-exports (no behavior change)
22// -----------------------------------------------------------------------------
23
24pub mod access; // todo - potentially could be pub(crate) but custom errors would have to change
25pub mod api;
26pub mod bootstrap;
27#[doc(hidden)]
28pub mod dispatch;
29pub mod domain;
30pub mod dto;
31pub mod error;
32pub mod ids;
33pub mod log;
34pub mod perf;
35pub mod protocol;
36#[cfg(test)]
37pub mod test;
38
39pub(crate) mod config;
40pub(crate) mod infra;
41pub(crate) mod lifecycle;
42pub(crate) mod ops;
43pub(crate) mod storage;
44pub(crate) mod workflow;
45
46pub use {
47    ::canic_cdk as cdk,
48    ::canic_memory as memory,
49    ::canic_memory::{eager_init, eager_static, ic_memory, ic_memory_range},
50    ::canic_utils as utils,
51};
52
53pub(crate) use error::{InternalError, InternalErrorClass, InternalErrorOrigin};
54
55/// Internal re-exports required for macro expansion.
56/// Not part of the public API.
57#[doc(hidden)]
58pub mod __reexports {
59    pub use ::ctor;
60}
61
62///
63/// Consts
64///
65
66pub const CRATE_NAME: &str = env!("CARGO_PKG_NAME");
67pub const VERSION: &str = env!("CARGO_PKG_VERSION");
canic_core/lib.rs

canic_core/
lib.rs
