canic 0.110.15

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

///
/// Structured public runtime API surface.
///
/// This module groups Canic’s runtime capabilities by intent (auth, calls,
/// canister topology, observability, scheduling) rather than mirroring internal
/// core layout.
///

/// Authentication workflow helpers
pub mod auth {
    pub use crate::__internal::core::api::auth::AuthApi;
}

/// Blob-storage protocol helpers.
#[cfg(feature = "blob-storage")]
pub mod blob_storage {
    pub use crate::__internal::core::api::blob_storage::BlobStorageApi;
}

/// Local and receipt-backed reservation helpers.
pub mod intent {
    pub use crate::__internal::core::api::intent::{
        BeginLocalIntentInput, BeginReceiptBackedIntentInput, BeginReceiptBackedIntentResult,
        IntentId, IntentResourceKey, LocalIntentApi, OperationId, PayloadBinding,
        ReceiptBackedIntent, ReceiptBackedIntentApi, ReceiptBackedIntentState,
        SettleReceiptBackedIntentInput, SettleReceiptBackedIntentResult, TerminalEvidence,
        TerminalEvidenceDecision,
    };
}

/// Instrumented inter-canister call construction and response decoding.
pub mod call {
    pub use crate::__internal::core::api::call::{Call, CallBuilder, CallResult};
}

/// Environment queries
pub mod env {
    pub use crate::__internal::core::api::env::EnvQuery;
}

/// Canister lifecycle, placement, and topology
pub mod canister {
    pub use crate::__internal::core::ids::CanisterRole;

    pub mod children {
        pub use crate::__internal::core::api::topology::children::CanisterChildrenApi;
    }

    /// Root-local Component Registry membership lookup.
    #[cfg(feature = "control-plane")]
    pub mod component {
        pub use canic_control_plane::api::component_auth::RootComponentMembershipApi;
    }

    /// Immutable deployment policy and the current protected Component runtime view.
    pub mod deployment {
        pub use crate::__internal::core::api::{
            component_deployment::ComponentDeploymentApi, component_runtime::ComponentRuntimeApi,
        };
    }

    pub mod placement {
        pub use crate::__internal::core::api::placement::index::PlacementIndexApi;
        pub use crate::__internal::core::api::placement::scaling::ScalingApi;

        #[cfg(feature = "sharding")]
        pub use crate::__internal::core::api::placement::sharding::ShardingApi;
    }

    #[cfg(any(feature = "control-plane", feature = "wasm-store-canister"))]
    pub mod template {
        #[cfg(feature = "wasm-store-canister")]
        pub use canic_control_plane::api::template::WasmStoreCanisterApi;
        #[cfg(feature = "control-plane")]
        pub use canic_control_plane::api::template::{
            WasmStoreBootstrapApi, WasmStorePublicationApi,
        };
    }
}

/// RPC abstractions (non-IC-specific)
pub mod rpc {
    pub use crate::__internal::core::api::rpc::RpcApi;
}

/// Runtime bootstrap helpers
pub mod runtime {
    pub use crate::__internal::core::api::{ready::ReadyApi, runtime::MemoryRuntimeApi};
}

/// Protocol runtime helpers
pub mod protocol {
    pub mod icrc21 {
        pub use crate::__internal::core::dispatch::icrc21::Icrc21Dispatcher;
    }
}

/// Observability and operational helpers
pub mod public_status {
    pub use crate::__internal::core::api::public_status::{
        ApplicationMetricsSampler, PublicStatusApi,
    };
}

pub mod metrics {
    pub use crate::__internal::core::api::metrics::MetricsQuery;
}

/// Low-level operational helpers
pub mod ops {
    pub use crate::__internal::core::{log, perf};
}

/// Registered application fixture consumption and exact receipt observation.
pub mod fixture_provisioning {
    pub use crate::__internal::core::api::fixture_provisioning::{
        FixtureImporter, FixtureProvisioningApi,
    };
}