canic 0.110.23

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

//! Canic facade crate.
//!
//! This crate is the recommended dependency for downstream canister projects. It
//! re-exports the public Canic runtime surface and provides the common macro entry points:
//!
//! - `build!` for configured canisters and generated local sandbox/probe config
//! - `start!` for configured canister lifecycle hooks and endpoints
//! - `start_fleet_coordinator!` for Canic's canonical Coordinator artifact source
//!
//! For lower-level access, use the `api`, `dto`, and `memory` modules.
//! These surfaces are for configured canister role packages. Shared runtime
//! libraries should remain independent of Canic and use upstream crates such
//! as `candid` or `ic-cdk` directly when they need generic IC types or APIs.
//! Direct access to internal core modules is intentionally unsupported.

#![deny(unreachable_pub)]

pub mod access;
pub mod api;
#[cfg(any(not(target_arch = "wasm32"), test))]
mod build_support;
pub mod diagnostics;
pub mod dto;
pub mod fleet_admission;
pub mod ids;
mod instructions;
mod macros; // private implementation boundary
pub mod prelude;
pub mod protocol;
#[cfg(all(feature = "testing", not(target_arch = "wasm32")))]
pub mod testing;

#[doc(hidden)]
pub mod __internal {
    // NOTE:
    // This module exists ONLY for macro expansion.
    // Do NOT re-export canic_core publicly.
    pub use candid;
    #[cfg(any(
        feature = "control-plane",
        feature = "fleet-coordinator-canister",
        feature = "wasm-store-canister"
    ))]
    pub use canic_control_plane as control_plane;
    pub use canic_core as core;
    pub use serde;

    pub mod cdk {
        pub use candid::Principal;
        pub use ic_cdk::{
            export_candid, futures, init, inspect_message, post_upgrade, query, trap, update,
        };

        pub mod api {
            pub use ic_cdk::api::{
                canister_cycle_balance, canister_version, is_controller, msg_caller, msg_reply,
                time,
            };
        }

        pub mod raw {
            pub use ic0::{msg_arg_data_copy, msg_arg_data_size};
        }
    }

    pub mod instructions {
        pub use crate::instructions::format_instructions;
    }
}

#[doc(hidden)]
#[cfg(any(not(target_arch = "wasm32"), test))]
pub mod __build {
    pub use crate::build_support::{
        CANIC_CUSTOM_CFG_NAMES, METRICS_TIER_CORE, METRICS_TIER_PLACEMENT, METRICS_TIER_PLATFORM,
        METRICS_TIER_RUNTIME, METRICS_TIER_SECURITY, METRICS_TIER_STORAGE,
        assert_canonical_role_contract_build, compile_role_build_sources, config_app_id,
        config_contains_role, config_declares_role, configured_role_metrics_tier_mask,
        declared_package_metadata, declared_package_role, metrics_profile_tier_mask,
        read_config_source_or_default, required_package_metadata, required_package_role,
        write_build_source_if_changed,
    };
}

// -----------------------------------------------------------------------------
// Sub-crates
// -----------------------------------------------------------------------------
pub use canic_core::memory;

// -----------------------------------------------------------------------------
// Re-exports
// -----------------------------------------------------------------------------
pub use canic_core::dto::error::Error;
pub use canic_core::{impl_storable_bounded, impl_storable_unbounded};
pub use canic_macros::{canic_query, canic_update};
pub use diagnostics::{DiagnosticCode, RegisteredDiagnosticCode};

// -----------------------------------------------------------------------------
// Constants
// -----------------------------------------------------------------------------

pub const VERSION: &str = env!("CARGO_PKG_VERSION");
pub const CANIC_WASM_CHUNK_BYTES: usize = canic_core::CANIC_WASM_CHUNK_BYTES;
pub const CANIC_DEFAULT_UPDATE_INGRESS_MAX_BYTES: usize =
    canic_core::ingress::payload::DEFAULT_UPDATE_INGRESS_MAX_BYTES;