canic-core 0.86.1

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

//! Module: workflow::topology::index::query
//!
//! Responsibility: expose read-only app and subnet index pages and role lookups.
//! Does not own: index storage mutation, endpoint authorization, or DTO schemas.
//! Boundary: workflow query facade over index storage ops.

use crate::{
    cdk::types::Principal,
    dto::{
        page::{Page, PageRequest},
        topology::IndexEntryResponse,
    },
    ids::CanisterRole,
    ops::storage::index::{app::AppIndexOps, mapper::IndexEntryMapper, subnet::SubnetIndexOps},
    view::topology::IndexEntryView,
    workflow::view::paginate::paginate_vec,
};

///
/// AppIndexQuery
///

pub struct AppIndexQuery;

impl AppIndexQuery {
    #[must_use]
    pub fn get(role: CanisterRole) -> Option<Principal> {
        AppIndexOps::get(&role)
    }

    #[must_use]
    pub fn page(page: PageRequest) -> Page<IndexEntryResponse> {
        index_page(AppIndexOps::entry_projections(), page)
    }
}

///
/// SubnetIndexQuery
///

pub struct SubnetIndexQuery;

impl SubnetIndexQuery {
    #[must_use]
    pub fn get(role: CanisterRole) -> Option<Principal> {
        SubnetIndexOps::get(&role)
    }

    #[must_use]
    pub fn page(page: PageRequest) -> Page<IndexEntryResponse> {
        index_page(SubnetIndexOps::entry_projections(), page)
    }
}

// Paginate read-only index projections and let ops own response mapping.
fn index_page(entries: Vec<IndexEntryView>, page: PageRequest) -> Page<IndexEntryResponse> {
    IndexEntryMapper::projection_page_to_response(paginate_vec(entries, page))
}