icydb-core 0.94.0

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

//! Module: db::cursor::range_token
//! Defines executor-owned continuation payloads for index-range traversal
//! without leaking physical key bytes across layers.

use crate::db::{
    access::LoweredKey,
    cursor::{IndexRangeCursorAnchor, ValidatedInEnvelopeIndexRangeCursorAnchor},
    index::RawIndexKey,
};

///
/// LogicalKeyHandle
///
/// Executor-owned logical handle for lowered index keys.
/// Keeps physical key representation behind the storage-port boundary.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::db) struct LogicalKeyHandle {
    lowered_key: LoweredKey,
}

impl LogicalKeyHandle {
    #[must_use]
    pub(in crate::db) const fn from_lowered(lowered_key: LoweredKey) -> Self {
        Self { lowered_key }
    }

    #[must_use]
    pub(in crate::db) const fn as_lowered(&self) -> &LoweredKey {
        &self.lowered_key
    }
}

///
/// RangeToken
///
/// Executor-owned continuation token payload for index-range scans.
/// Route/load layers carry this token without touching physical key bytes.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::db) struct RangeToken {
    anchor: LogicalKeyHandle,
}

impl RangeToken {
    #[must_use]
    pub(in crate::db) const fn new(anchor: LogicalKeyHandle) -> Self {
        Self { anchor }
    }

    #[must_use]
    pub(in crate::db) const fn anchor(&self) -> &LogicalKeyHandle {
        &self.anchor
    }
}

/// Build a continuation anchor directly from one raw index key.
#[must_use]
pub(in crate::db) fn cursor_anchor_from_raw_index_key(
    index_key: &RawIndexKey,
) -> IndexRangeCursorAnchor {
    IndexRangeCursorAnchor::new(index_key.as_bytes().to_vec())
}

/// Decode one continuation anchor into one executor range token.
#[must_use]
pub(in crate::db) fn range_token_from_validated_cursor_anchor(
    anchor: &ValidatedInEnvelopeIndexRangeCursorAnchor,
) -> RangeToken {
    RangeToken::new(LogicalKeyHandle::from_lowered(anchor.lowered_key().clone()))
}

/// Borrow the lowered anchor key carried by one range token.
#[must_use]
pub(in crate::db) const fn range_token_anchor_key(range_token: &RangeToken) -> &LoweredKey {
    range_token.anchor().as_lowered()
}