canic-core 0.42.13

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

use crate::{
    cdk::structures::{DefaultMemoryImpl, memory::VirtualMemory},
    storage::{prelude::*, stable::memory::topology::SUBNET_INDEX_ID},
};
use ic_memory::stable_structures::btreemap::BTreeMap as StableBtreeMap;
use std::cell::RefCell;

eager_static! {
    static SUBNET_INDEX: RefCell<StableBtreeMap<CanisterRole, Principal, VirtualMemory<DefaultMemoryImpl>>> =
        RefCell::new(StableBtreeMap::init(crate::ic_memory_key!("canic.core.subnet_index.v1", SubnetIndex, SUBNET_INDEX_ID)));
}

///
/// SubnetIndexRecord
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct SubnetIndexRecord {
    pub entries: Vec<(CanisterRole, Principal)>,
}

///
/// SubnetIndex
///
/// Stable-memory–backed model relation mapping subnet-scoped canister
/// roles to their principals.
///
/// Invariants:
/// - Each role appears at most once.
/// - This index is authoritative and replaced wholesale on import.
/// - DTO/snapshot representations are constructed in higher layers.
///

pub struct SubnetIndex;

impl SubnetIndex {
    // cannot return an iterator because of stable memory
    #[must_use]
    pub(crate) fn export() -> SubnetIndexRecord {
        SubnetIndexRecord {
            entries: SUBNET_INDEX.with_borrow(|map| {
                map.iter()
                    .map(|entry| (entry.key().clone(), entry.value()))
                    .collect()
            }),
        }
    }

    pub(crate) fn import(data: SubnetIndexRecord) {
        SUBNET_INDEX.with_borrow_mut(|map| {
            map.clear_new();
            for (role, pid) in data.entries {
                map.insert(role, pid);
            }
        });
    }
}