canic-core 0.110.8

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

//! DTO boundary definitions.
//!
//! ## Design rules
//!
//! - DTOs are **passive transport types**. They contain no domain logic, policy,
//!   validation, normalization, or invariant enforcement.
//!
//! - DTOs do **not claim guarantees that Candid cannot enforce**. In particular,
//!   uniqueness, ordering, and keyed semantics are not preserved at the wire
//!   level and must not be relied upon.
//!
//! - All authoritative invariants (e.g. ownership, uniqueness, replacement
//!   semantics) live in **storage and ops layers**, never in DTOs.
//! - Data exported from stable registries is treated as a **snapshot** of state,
//!   not a live or authoritative registry.
//!
//! - DTOs therefore prefer simple list representations (`Vec<T>`). When keyed
//!   data is needed, define small entry structs (`FooEntry`) instead of
//!   tuples or maps. More structured shapes are used only when they materially
//!   reduce complexity for consumers, not to mirror storage internals or
//!   reintroduce lost semantics.
//!
//! - Avoid `HashMap` in DTOs. Keyed semantics and ordering are not preserved at
//!   the boundary; use `Vec<...Entry>` or explicit list types instead.
//!
//! In short: stable storage is authoritative; DTOs describe how data is
//! transported, not what guarantees it provides.

pub mod abi;
pub mod auth;
pub mod authority_restore;
pub mod blob_storage;
pub mod canister;
pub mod capability;
pub mod cascade;
pub mod component_deployment;
pub mod component_provisioning;
pub mod component_registry;
pub mod cycles;
pub mod env;
pub mod error;
pub mod fleet_activation;
pub mod fleet_admission;
pub mod fleet_funding;
pub mod fleet_registry;
pub mod fleet_subnet_root;
pub mod icp_refill;
pub mod icrc21;
pub mod log;
pub mod memory;
pub mod metadata;
pub mod metrics;
pub mod observability;
pub mod page;
pub mod placement;
pub mod pool;
pub mod role;
pub mod root_store;
pub mod rpc;
pub mod runtime;
pub mod state;

///
/// Prelude
///

pub mod prelude {
    pub use crate::ids::{CanisterRole, ComponentSpecId};
    pub use candid::{CandidType, Nat, Principal};
    pub use serde::{Deserialize, Serialize};
}