canic-core 0.21.2

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

use crate::dto::{canister::CanisterInfo, prelude::*};

///
/// AppRegistryResponse
///

#[derive(CandidType, Deserialize)]
pub struct AppRegistryResponse(pub Vec<AppRegistryEntry>);

///
/// AppRegistryEntry
///

#[derive(CandidType, Deserialize)]
pub struct AppRegistryEntry {
    pub subnet_pid: Principal,
    pub root_pid: Principal,
}

///
/// SubnetRegistryResponse
///
/// External view of the subnet registry.
/// Each entry is identity-bearing (`pid`) and includes the full
/// canister record payload.
///

#[derive(CandidType, Deserialize)]
pub struct SubnetRegistryResponse(pub Vec<SubnetRegistryEntry>);

///
/// SubnetRegistryEntry
///
/// Registry entry keyed by canister principal.
/// The `role` is duplicated outside the record for convenient
/// filtering and indexing by consumers.
///

#[derive(CandidType, Deserialize)]
pub struct SubnetRegistryEntry {
    pub pid: Principal,
    pub role: CanisterRole,
    pub record: CanisterInfo,
}

///
/// AppDirectoryArgs
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct AppDirectoryArgs(pub Vec<DirectoryEntryInput>);

///
/// SubnetDirectoryArgs
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct SubnetDirectoryArgs(pub Vec<DirectoryEntryInput>);

///
/// DirectoryEntryInput
///

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct DirectoryEntryInput {
    pub role: CanisterRole,
    pub pid: Principal,
}

///
/// DirectoryEntryResponse
///

#[derive(CandidType, Debug, Deserialize, Eq, PartialEq)]
pub struct DirectoryEntryResponse {
    pub role: CanisterRole,
    pub pid: Principal,
}