canic-core 0.39.11

Canic — a canister orchestration and management toolkit for the Internet Computer
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! Core Canic library used inside canisters.
//!
//! Most users should depend on the `canic` facade crate, which re-exports this crate
//! under `canic::core` and exposes the common entrypoint macros:
//! - `canic::build!` / `canic::build_root!` (in `build.rs`) to validate/embed `canic.toml`
//! - `canic::start!` / `canic::start_root!` (in `lib.rs`) to wire lifecycle hooks and export endpoints
//!
//! ## Layering
//!
//! Canic is organized to keep endpoint code thin and coordination centralized:
//! - `access/` contains access expressions, predicates, and metrics for boundary enforcement.
//! - `workflow/` implements orchestration and lifecycle workflows.
//! - `domain/` contains pure value and decision helpers.
//! - `ops/` provides mechanical, reusable side-effecting operations.
//! - `storage/` owns stable-memory-backed schemas and helpers.
//! - `view/` exposes internal read-only projections over stored/runtime state.
//! - macro entrypoints live in the `canic` facade crate.
//!
//! The default flow is: endpoints → workflow → domain/decision helpers → ops → storage.

#[doc(hidden)]
pub mod access;
pub mod api;
#[doc(hidden)]
pub mod bootstrap;
#[doc(hidden)]
pub mod control_plane_support;
#[doc(hidden)]
pub mod dispatch;
pub mod dto;
#[doc(hidden)]
pub mod error;
mod format;
pub mod ids;
#[doc(hidden)]
pub mod ingress;
pub mod log;
pub mod memory;
mod memory_macros;
pub mod perf;
pub mod protocol;
#[doc(hidden)]
pub mod shared_support;
#[cfg(test)]
pub mod test;

pub(crate) mod config;
pub(crate) mod domain;
pub(crate) mod infra;
pub(crate) mod lifecycle;
pub(crate) mod ops;
pub(crate) mod storage;
pub(crate) mod view;
pub(crate) mod workflow;

pub use ::canic_cdk as cdk;

pub(crate) use error::{InternalError, InternalErrorClass, InternalErrorOrigin};

/// Internal re-exports required for macro expansion.
/// Not part of the public API.
#[doc(hidden)]
pub mod __reexports {
    pub use ::ctor;
}

///
/// Consts
///

pub const CRATE_NAME: &str = env!("CARGO_PKG_NAME");
pub const VERSION: &str = env!("CARGO_PKG_VERSION");
pub const CANIC_MEMORY_MIN: u8 = storage::stable::CANIC_MEMORY_MIN;
pub const CANIC_MEMORY_MAX: u8 = storage::stable::CANIC_MEMORY_MAX;
// Canonical hardcoded 1 MiB chunk size for Canic wasm staging/install flows.
// The management canister wasm chunk store rejects larger payloads.
pub const CANIC_WASM_CHUNK_BYTES: usize = 1_048_576;

#[cfg(test)]
const _: () = {
    fn __canic_memory_test_bootstrap() {
        crate::api::runtime::MemoryRuntimeApi::bootstrap_registry()
            .expect("test stable-memory bootstrap");
    }

    #[crate::__reexports::ctor::ctor(
        unsafe,
        anonymous,
        crate_path = crate::__reexports::ctor
    )]
    fn __canic_install_memory_test_bootstrap_hook() {
        crate::memory::runtime::install_test_bootstrap_hook(__canic_memory_test_bootstrap);
    }
};

#[macro_export]
macro_rules! perf {
    ($($label:tt)*) => {{
        $crate::perf::PERF_LAST.with(|last| {
            let now = $crate::perf::perf_counter();
            let then = *last.borrow();
            let delta = now.saturating_sub(then);

            *last.borrow_mut() = now;

            let label = format!($($label)*);
            $crate::perf::record_checkpoint(module_path!(), &label, delta);
        });
    }};
}

#[cfg(test)]
#[macro_export]
macro_rules! assert_err_variant {
    ($err:expr, $pat:pat $(if $guard:expr)? $(,)?) => {{
        match $err {
            $pat $(if $guard)? => {}
            other => panic!("unexpected error variant: {other:?}"),
        }
    }};
}

#[cfg(test)]
mod memory_bootstrap_tests {
    #[test]
    fn installs_host_test_bootstrap_hook() {
        assert!(crate::memory::runtime::has_test_bootstrap_hook());
    }
}