icydb-core 0.70.0

IcyDB — A type-safe, embedded ORM and schema system 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! Module: db::executor::continuation::grouped::capabilities
//! Responsibility: grouped continuation capability projection from grouped pagination shape.
//! Does not own: grouped route derivation or grouped fold execution behavior.
//! Boundary: continuation authority for grouped capability flags.

use crate::db::executor::GroupedPaginationWindow;

///
/// GroupedContinuationCapabilities
///
/// Immutable grouped continuation capability projection derived from grouped
/// cursor-application state and grouped pagination window shape.
/// Grouped route/fold layers consume this capability contract instead of
/// re-deriving continuation gates from raw window primitives.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(in crate::db::executor) struct GroupedContinuationCapabilities {
    applied: bool,
    resume_boundary_applied: bool,
    selection_bound_applied: bool,
}

impl GroupedContinuationCapabilities {
    /// Construct one grouped continuation capability projection from grouped paging window shape.
    #[must_use]
    pub(in crate::db::executor) const fn from_window(
        applied: bool,
        window: &GroupedPaginationWindow,
    ) -> Self {
        Self {
            applied,
            resume_boundary_applied: window.resume_boundary().is_some(),
            selection_bound_applied: window.selection_bound().is_some(),
        }
    }

    /// Return whether grouped continuation is applied for this execution.
    #[must_use]
    pub(in crate::db::executor) const fn applied(self) -> bool {
        self.applied
    }

    /// Return whether grouped resume-boundary filtering is active.
    #[must_use]
    pub(in crate::db::executor) const fn resume_boundary_applied(self) -> bool {
        self.resume_boundary_applied
    }

    /// Return whether grouped candidate selection bound is active.
    #[must_use]
    pub(in crate::db::executor) const fn selection_bound_applied(self) -> bool {
        self.selection_bound_applied
    }
}

///
/// TESTS
///

#[cfg(test)]
mod tests {
    use crate::db::executor::{GroupedContinuationCapabilities, GroupedPaginationWindow};

    #[test]
    fn grouped_continuation_capabilities_mark_initial_window_as_unapplied() {
        let window = GroupedPaginationWindow {
            limit: Some(3),
            initial_offset_for_page: 2,
            selection_bound: Some(6),
            resume_initial_offset: 2,
            resume_boundary: None,
        };
        let capabilities = GroupedContinuationCapabilities::from_window(false, &window);

        assert!(!capabilities.applied());
        assert!(!capabilities.resume_boundary_applied());
        assert!(capabilities.selection_bound_applied());
    }

    #[test]
    fn grouped_continuation_capabilities_mark_resume_window_as_applied() {
        let window = GroupedPaginationWindow {
            limit: Some(3),
            initial_offset_for_page: 0,
            selection_bound: Some(4),
            resume_initial_offset: 2,
            resume_boundary: Some(crate::value::Value::List(Vec::new())),
        };
        let capabilities = GroupedContinuationCapabilities::from_window(true, &window);

        assert!(capabilities.applied());
        assert!(capabilities.resume_boundary_applied());
        assert!(capabilities.selection_bound_applied());
    }
}