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

//! Module: index::key::codec::bounds
//! Responsibility: byte-size bounds/constants for index-key framing.
//! Does not own: parsing logic or semantic key construction.
//! Boundary: consumed by codec encode/decode helpers.

use crate::{
    MAX_INDEX_FIELDS,
    db::{
        data::StorageKey,
        index::{IndexId, key::codec::IndexKey},
    },
};

pub(super) const KEY_KIND_TAG_SIZE: usize = 1;
pub(super) const COMPONENT_COUNT_SIZE: usize = 1;
pub(super) const SEGMENT_LEN_SIZE: usize = 2;
pub(super) const INDEX_ID_SIZE: usize = IndexId::STORED_SIZE_USIZE;
pub(super) const KEY_PREFIX_SIZE: usize = KEY_KIND_TAG_SIZE + INDEX_ID_SIZE + COMPONENT_COUNT_SIZE;

#[expect(clippy::cast_possible_truncation)]
impl IndexKey {
    pub(crate) const MAX_COMPONENT_SIZE: usize = 4 * 1024;
    pub(crate) const MAX_PK_SIZE: usize = StorageKey::STORED_SIZE_USIZE;

    const MIN_SEGMENT_SIZE: usize = 1;

    /// Maximum on-disk size in bytes (stable, protocol-level bound)
    pub(crate) const MAX_INDEX_KEY_BYTES: u64 = (KEY_PREFIX_SIZE
        + (MAX_INDEX_FIELDS * (SEGMENT_LEN_SIZE + Self::MAX_COMPONENT_SIZE))
        + (SEGMENT_LEN_SIZE + Self::MAX_PK_SIZE))
        as u64;

    /// Maximum on-disk size in bytes (stable, protocol-level bound)
    pub(crate) const STORED_SIZE_BYTES: u64 = Self::MAX_INDEX_KEY_BYTES;

    /// Maximum in-memory size (for bounds checks)
    pub(crate) const STORED_SIZE_USIZE: usize = Self::STORED_SIZE_BYTES as usize;

    /// Minimum encoded size for an empty index key.
    pub(crate) const MIN_STORED_SIZE_BYTES: u64 =
        (KEY_PREFIX_SIZE + SEGMENT_LEN_SIZE + Self::MIN_SEGMENT_SIZE) as u64;

    /// Minimum encoded size for an empty index key.
    pub(crate) const MIN_STORED_SIZE_USIZE: usize = Self::MIN_STORED_SIZE_BYTES as usize;

    #[must_use]
    pub(crate) fn wildcard_low_component() -> Vec<u8> {
        vec![0]
    }

    #[must_use]
    pub(crate) fn wildcard_high_component() -> Vec<u8> {
        vec![0xFF; Self::MAX_COMPONENT_SIZE]
    }

    #[must_use]
    pub(crate) fn wildcard_low_pk() -> Vec<u8> {
        vec![0]
    }

    #[must_use]
    pub(crate) fn wildcard_high_pk() -> Vec<u8> {
        vec![0xFF; Self::MAX_PK_SIZE]
    }
}