canic-core 0.25.0

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

use crate::{
    config::schema::CanisterKind,
    dto::{
        canister::CanisterInfo,
        page::{Page, PageRequest},
    },
    ids::CanisterRole,
    log,
    log::Topic,
    ops::{config::ConfigOps, storage::children::CanisterChildrenOps},
    workflow::view::paginate::paginate_vec,
};

///
/// CanisterChildrenQuery
///

pub struct CanisterChildrenQuery;

impl CanisterChildrenQuery {
    #[must_use]
    pub fn page(page: PageRequest) -> Page<CanisterInfo> {
        let entries = CanisterChildrenOps::infos();

        paginate_vec(entries, page)
    }

    /// Returns the per-parent singleton child for `role`, if present.
    /// Valid only for kind = Singleton.
    #[must_use]
    pub fn get_singleton_child(role: &CanisterRole) -> Option<CanisterInfo> {
        let kind = match ConfigOps::current_subnet_canister(role) {
            Ok(cfg) => cfg.kind,
            Err(err) => {
                log!(
                    Topic::Topology,
                    Warn,
                    "get_singleton_child({role}) skipped: config lookup failed ({err})"
                );
                return None;
            }
        };

        if kind != CanisterKind::Singleton {
            log!(
                Topic::Topology,
                Error,
                "get_singleton_child({role}) invalid for kind={kind:?}"
            );
            return None;
        }

        CanisterChildrenOps::infos()
            .into_iter()
            .find(|entry| &entry.role == role)
    }

    /// Returns all children with the given role.
    /// Intended for replica, tenant, or shard kinds.
    #[must_use]
    pub fn list_children_by_role(role: &CanisterRole) -> Vec<CanisterInfo> {
        CanisterChildrenOps::infos()
            .into_iter()
            .filter(|entry| &entry.role == role)
            .collect()
    }
}