canic-core 0.26.1

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

//! Public API façade for canister endpoints.
//!
//! This module contains thin wrappers exposed to proc-macro–generated
//! endpoints. Functions here translate public API calls into internal
//! workflow or ops calls and map internal errors into `Error`.
//!
//! No orchestration or business logic should live here.
//! Any wrapper callable from an endpoint must return a `Result` so errors
//! are consistently mapped at the boundary.

pub mod auth;
pub mod cascade;
pub mod config;
pub mod error;
pub mod ic;
pub mod lifecycle;
pub mod placement;
pub mod pool;
pub mod ready;
pub mod rpc;
pub mod runtime;
pub mod standards;
pub mod state;
pub mod timer;
pub mod topology;

///
/// Workflow Query Re-exports
///
/// Only queries that satisfy ALL of the following may be re-exported directly:
///
/// - Read-only
/// - No orchestration or side effects
/// - No policy or invariant enforcement
/// - No internal `InternalError` in public signatures
/// - Return DTOs or primitives only
///
/// Queries that can fail with internal errors or enforce invariants
/// MUST be wrapped in an API façade instead.
///

pub mod cycles {
    pub use crate::workflow::runtime::cycles::query::CycleTrackerQuery;
}
pub mod env {
    pub use crate::workflow::env::query::EnvQuery;
}
pub mod icrc {
    pub use crate::workflow::icrc::query::{Icrc10Query, Icrc21Query};
}
pub mod log {
    pub use crate::workflow::log::query::LogQuery;
}
pub mod memory {
    pub use crate::workflow::memory::query::MemoryQuery;
}
pub mod metrics {
    pub use crate::workflow::metrics::query::MetricsQuery;
}