icydb 0.84.2

IcyDB — A schema-first typed query engine and persistence runtime for Internet Computer canisters
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

use crate::traits::EntityKind;

///
/// PagedResponse
///
/// Public cursor-pagination payload for load queries.
/// The `next_cursor` token is opaque and must be treated as an uninterpreted string.
/// Ordering is deterministic for each request under the query's canonical order.
/// Continuation is best-effort and forward-only over live state.
/// Pagination is not snapshot-isolated: no snapshot/version is pinned across requests, so
/// concurrent writes may shift boundaries.
///

pub struct PagedResponse<E: EntityKind> {
    items: Vec<E>,
    next_cursor: Option<String>,
}

impl<E: EntityKind> PagedResponse<E> {
    pub(crate) const fn new(items: Vec<E>, next_cursor: Option<String>) -> Self {
        Self { items, next_cursor }
    }

    #[must_use]
    pub fn items(&self) -> &[E] {
        &self.items
    }

    #[must_use]
    pub fn next_cursor(&self) -> Option<&str> {
        self.next_cursor.as_deref()
    }

    #[must_use]
    pub fn into_items(self) -> Vec<E> {
        self.items
    }

    #[must_use]
    pub fn into_next_cursor(self) -> Option<String> {
        self.next_cursor
    }
}

///
/// PagedGroupedResponse
///
/// Public grouped pagination payload.
/// Grouped rows stay in the core grouped-row representation so grouped value
/// fidelity and execution tracing remain intact at the facade boundary.
///
#[derive(Debug)]
pub struct PagedGroupedResponse {
    items: Vec<icydb_core::db::GroupedRow>,
    next_cursor: Option<String>,
    execution_trace: Option<icydb_core::db::ExecutionTrace>,
}

impl PagedGroupedResponse {
    pub(crate) const fn new(
        items: Vec<icydb_core::db::GroupedRow>,
        next_cursor: Option<String>,
        execution_trace: Option<icydb_core::db::ExecutionTrace>,
    ) -> Self {
        Self {
            items,
            next_cursor,
            execution_trace,
        }
    }

    #[must_use]
    pub fn items(&self) -> &[icydb_core::db::GroupedRow] {
        &self.items
    }

    #[must_use]
    pub fn next_cursor(&self) -> Option<&str> {
        self.next_cursor.as_deref()
    }

    #[must_use]
    pub const fn execution_trace(&self) -> Option<icydb_core::db::ExecutionTrace> {
        self.execution_trace
    }

    #[must_use]
    pub fn into_items(self) -> Vec<icydb_core::db::GroupedRow> {
        self.items
    }

    #[must_use]
    pub fn into_next_cursor(self) -> Option<String> {
        self.next_cursor
    }

    #[must_use]
    pub fn into_execution_trace(self) -> Option<icydb_core::db::ExecutionTrace> {
        self.execution_trace
    }
}