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;
26#[doc(hidden)]
27pub mod dispatch;
28pub mod domain;
29pub mod dto;
30pub mod error;
31pub mod ids;
32pub mod log;
33pub mod perf;
34pub mod protocol;
35#[cfg(test)]
36pub mod test;
37
38pub(crate) mod config;
39pub(crate) mod infra;
40pub(crate) mod lifecycle;
41pub(crate) mod ops;
42pub(crate) mod storage;
43pub(crate) mod workflow;
44
45pub use {
46    ::canic_cdk as cdk,
47    ::canic_memory as memory,
48    ::canic_memory::{eager_init, eager_static, ic_memory, ic_memory_range},
49    ::canic_utils as utils,
50};
51
52pub(crate) use error::{InternalError, InternalErrorClass, InternalErrorOrigin};
53
54/// Internal re-exports required for macro expansion.
55/// Not part of the public API.
56#[doc(hidden)]
57pub mod __reexports {
58    pub use ::ctor;
59}
60
61///
62/// Crate Version
63///
64
65pub const CRATE_NAME: &str = env!("CARGO_PKG_NAME");
66pub const VERSION: &str = env!("CARGO_PKG_VERSION");
67
68// init and validate config
69// called from here as config is pub(crate)
70pub fn init_config(toml: &str) -> Result<(), String> {
71    config::Config::init_from_toml(toml)
72        .map(|_| ())
73        .map_err(|err| err.to_string())
74}
canic_core/lib.rs

canic_core/
lib.rs
