canic-core 0.69.5

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

//! Module: view::placement::sharding
//!
//! Responsibility: define sharding placement read-only projections.
//! Does not own: sharding policy, shard records, or endpoint DTOs.
//! Boundary: ops mappers produce these views for sharding workflows.

use crate::cdk::candid::Principal;

///
/// ShardPlacement
///
/// Read-only projection of one shard placement slot.
/// Owned by view and produced by sharding placement ops mappers.
///

#[derive(Clone, Debug)]
pub struct ShardPlacement {
    pub pool: String,
    pub slot: u32,
    pub capacity: u32,
    pub count: u32,
}

impl ShardPlacement {
    pub const UNASSIGNED_SLOT: u32 = u32::MAX;
}

///
/// ShardPartitionKeyAssignment
///
/// Read-only projection of one partition key assignment.
/// Owned by view and produced by sharding placement ops mappers.
///

#[derive(Clone, Debug)]
pub struct ShardPartitionKeyAssignment {
    pub partition_key: String,
    pub pid: Principal,
}

///
/// ShardingPlanState
///
/// Outcome variants of a shard plan.
/// Owned by view and consumed by sharding workflow orchestration.
///

#[derive(Clone, Debug)]
pub enum ShardingPlanState {
    AlreadyAssigned { pid: Principal },
    UseExisting { pid: Principal },
    CreateAllowed,
    CreateBlocked { reason: CreateBlockedReason },
}

///
/// CreateBlockedReason
///
/// Reason a shard creation plan cannot proceed.
/// Owned by view and surfaced through sharding plan state.
///

#[derive(Clone, Debug, Eq, thiserror::Error, PartialEq)]
pub enum CreateBlockedReason {
    #[error("pool at capacity")]
    PoolAtCapacity,

    #[error("no free shard slots")]
    NoFreeSlots,

    #[error("{0}")]
    PolicyViolation(String),
}