canic-core 0.24.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

use crate::dto::prelude::*;

//
// ShardingRegistryEntry
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct ShardingRegistryEntry {
    pub pid: Principal,
    pub entry: ShardEntry,
}

//
// ShardingRegistryResponse
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct ShardingRegistryResponse(pub Vec<ShardingRegistryEntry>);

//
// ShardingPartitionKeysResponse
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct ShardingPartitionKeysResponse(pub Vec<String>);

//
// ShardEntry
//

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct ShardEntry {
    // Logical slot index within the pool (assigned deterministically).
    pub slot: u32,
    pub capacity: u32,
    pub count: u32,
    pub pool: String,
    pub canister_role: CanisterRole,
    pub created_at: u64,
}

//
// ShardingPlanStateResponse
//

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub enum ShardingPlanStateResponse {
    // Partition key already has a shard assigned.
    AlreadyAssigned { pid: Principal },

    // Partition key can be deterministically assigned to an existing shard (via HRW).
    UseExisting { pid: Principal },

    // Policy allows creation of a new shard.
    CreateAllowed,

    // Policy forbids creation of a new shard (e.g., capacity reached).
    CreateBlocked { reason: String },
}